List KYC forms

Get a list of the required KYC forms you need to submit to meet a specific country requirements.

List KYC forms

get

/kyc-forms

Authorizations

Query parameters

limitinteger · min: 1 · max: 100 · default: 10

Limits the number of results to return

reverseboolean · default: false

Order in which to retrieve the results

pageTokenstring · max: 8000

Pagination token that keeps of track of the current position in the list

countryCodestring · iso3166-1

Filter KYC forms by target country.

scopestring · enum

Filter KYC forms by scope.

Options: number, organization

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/kyc-forms' \
  --header 'Authorization: Bearer jwt'

200

200

{
  "nextPageToken": "text",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "scope": "number",
      "countryCode": "text",
      "conditions": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "status": "draft",
      "defaultLocale": [
        "en",
        "pt-BR"
      ],
      "questions": [
        {
          "locale": "text",
          "questions": [
            {
              "type": "stringArray",
              "key": "text",
              "description": "text",
              "placeholder": "text",
              "displayName": "text",
              "required": true,
              "format": "none",
              "timezone": "text",
              "conditions": [
                {
                  "key": "text",
                  "value": "text"
                }
              ],
              "options": [
                {
                  "key": "text",
                  "value": "text"
                }
              ]
            }
          ]
        }
      ],
      "createdAt": "2025-02-28T07:01:49.350Z",
      "updatedAt": "2025-02-28T07:01:49.350Z"
    }
  ]
}

OK