Update KYC form entry
Authorizations
Path parameters
organizationIdstringRequired
The organization ID
kycFormIdstring · uuidRequired
kycFormEntryIdstring · uuidRequired
Body
statusstring · enumOptionalPossible values:
The status of the form entry.
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
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-09-04T11:25:47.633Z",
"displayName": "text",
"tags": [
{
"key": "text",
"value": "text"
}
],
"updatedAt": "2025-09-04T11:25:47.633Z"
}
Last updated
Was this helpful?