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

Authorization

user

Query parameters

Response

200

OK

Body

application/json

nextPageTokenstring

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.

results*KycFormList

Request

JavaScriptCurlPython

const response = await fetch('/kyc-forms', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200

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