Get KYC form

Get KYC form

get

/kyc-forms/{kycFormId}

Authorizations

Path parameters

kycFormIdstring · uuidrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

404

200

{
  "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-21T18:17:04.308Z",
  "updatedAt": "2025-02-21T18:17:04.308Z"
}

OK