Create KYC form entry
Authorizations
Path parameters
organizationIdstringRequired
The organization ID
kycFormIdstring · uuidRequired
Body
localestring · locale-bcp47Required
businessProfileIdstring · uuidOptional
The ID of an existing Business Profile.
statusstring · enumOptionalPossible values:
The status of the form entry.
displayNamestringOptional
Responses
201
OK
application/json
403
Forbidden operation
application/json
404
Resource not found
application/json
422
Request validation failed
application/json
post
POST /organizations/{organizationId}/kyc-forms/{kycFormId}/entries HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 179
{
"locale": "text",
"businessProfileId": "123e4567-e89b-12d3-a456-426614174000",
"answers": [
{
"key": "text",
"valueString": "text",
"isDefault": true
}
],
"status": "draft",
"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-08-22T18:14:44.711Z",
"displayName": "text",
"tags": [
{
"key": "text",
"value": "text"
}
],
"updatedAt": "2025-08-22T18:14:44.711Z"
}
Last updated
Was this helpful?