/api/partner/v2/users/{userId}/agreements

cURL

curl --request GET \
  --url https://staging-api.capa.fi/api/partner/v2/users/{userId}/agreements \
  --header 'partner-api-key: <partner-api-key>'

{
  "success": true,
  "data": [
    {
      "url": "<string>"
    }
  ]
}

GET

api

partner

users

{userId}

agreements

cURL

curl --request GET \
  --url https://staging-api.capa.fi/api/partner/v2/users/{userId}/agreements \
  --header 'partner-api-key: <partner-api-key>'

{
  "success": true,
  "data": [
    {
      "url": "<string>"
    }
  ]
}

Retrieves the document signature templates (agreements) available for a user, including terms and conditions, privacy notices, and client agreements.

Error Codes

HTTP Status	Code	Message
401	`UNAUTHORIZED`	”API Key is missing”
401	`UNAUTHORIZED`	”Invalid API Key format”
401	`UNAUTHORIZED`	”Invalid API Key”
403	`INVALID_PARTNER_FLOW`	”The partner has an invalid flow.”

HTTP Status	Code	Message
401	`UNAUTHORIZED`	”Partner information is required for this operation”
401	`UNAUTHORIZED`	”User is not associated with the partner”

HTTP Status	Code	Message
500	`INTERNAL_SERVER_ERROR`	”Failed to read agreements”

partner-api-key

string

required

Api key for the affiliated partner that is performing the request

userId

string<uuid>

required

The user ID

200 - application/json

success

boolean

Example:

true

data

object[]

Show child attributes

⌘I