Get KYC form

Get KYC form

GET/kyc-forms/{kycFormId}

Authorization

user

Path parameters

kycFormId*string (uuid)

Response

200404

OK

Body

application/json

id*string (uuid)

name*string

scope*scope (enum)

numberorganization

countryCode*countryCode (string (iso3166-1))

conditionsconditions (object)

status*status (enum)

draftactivedeactivated

defaultLocale*Locale (enum)

afsqarazbnbgcazh-CNzh-HKzh-TWhrcsdanlenen-GBen-USetfilfifrkadeelguhahehihuidgaitjaknkkrw-RWkoky-KGlolvltmkmsmlmrnbfaplpt-BRpt-PTparorusrsksleses-ARes-ESes-MXswsvtatethtrukuruzvizu

questions*questions (array of object)

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

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

Response

200404

{
  "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": "2025-01-21T01:33:44.809Z",
  "updatedAt": "2025-01-21T01:33:44.809Z"
}