Get KYC form

Get KYC form

get

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

kycFormIdstring · uuidRequired

Responses

200

OK

application/json

idstring · uuidRequired

namestringRequired

scopestring · enumRequiredPossible values:

countryCodestring · iso3166-1Optional

statusstring · enumRequiredPossible values:

defaultLocalestring · locale-bcp47Required

gracePeriodDaysinteger · int64 · nullableOptional

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

404

Resource not found

application/json

get

/kyc-forms/{kycFormId}

HTTPcURLJavaScriptPython

GET /kyc-forms/{kycFormId} HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "scope": "number",
  "countryCode": "text",
  "conditions": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "status": "draft",
  "defaultLocale": "text",
  "questions": [
    {
      "locale": "text",
      "questions": [
        {
          "type": "bool",
          "key": "text",
          "description": "text",
          "placeholder": "text",
          "displayName": "text",
          "required": true,
          "mapping": "text",
          "format": "none",
          "conditions": [
            {
              "key": "text",
              "value": "text"
            }
          ],
          "options": [
            {
              "key": "text",
              "value": "text"
            }
          ],
          "timezone": "text"
        }
      ]
    }
  ],
  "gracePeriodDays": 1,
  "createdAt": "2026-03-09T13:45:40.218Z",
  "updatedAt": "2026-03-09T13:45:40.218Z"
}