Update KYC form entry

Update KYC Form Entry

patch

Authorizations

accessKey

HTTPRequired

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

Path parameters

organizationIdstringRequired

The organization ID

kycFormIdstring · uuidRequired

kycFormEntryIdstring · uuidRequired

Body

application/json

statusstring · enumOptional

The status of the form entry.

Possible values:

businessProfileIdstring · uuidOptional

The ID of an existing Business Profile.

displayNamestringOptional

Responses

200

OK

application/json

403

Forbidden operation

application/json

404

Resource not found

application/json

422

Request validation failed

application/json

patch

/organizations/{organizationId}/kyc-forms/{kycFormId}/entries/{kycFormEntryId}

HTTPcURLJavaScriptPython

PATCH /organizations/{organizationId}/kyc-forms/{kycFormId}/entries/{kycFormEntryId} HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 163

{
  "status": "draft",
  "businessProfileId": "123e4567-e89b-12d3-a456-426614174000",
  "answers": [
    {
      "key": "text",
      "valueString": "text",
      "isDefault": true
    }
  ],
  "displayName": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "formId": "123e4567-e89b-12d3-a456-426614174000",
  "locale": "text",
  "status": "draft",
  "businessProfileId": "123e4567-e89b-12d3-a456-426614174000",
  "businessProfileVersion": 1,
  "answers": [
    {
      "key": "text",
      "valueString": "text",
      "isDefault": true
    }
  ],
  "reviewComment": "text",
  "createdAt": "2025-12-16T19:06:08.800Z",
  "displayName": "text",
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "updatedAt": "2025-12-16T19:06:08.800Z"
}