DocumentaciónEngagement Platform API
Sign inGet started
Guides
API

Update KYC form entry

PATCH
/organizations/{organizationId}/kyc-forms/{kycFormId}/entries/{kycFormEntryId}
Update KYC Form Entry
Cuerpo de la solicitud
status
string
The status of the form entry.
Possible values: draft, submitted, approved, rejected, expired
businessProfileId
string
The ID of an existing Business Profile.
answers
array of object
Mostrar parámetros secundarios
answers.isDefault
boolean
answers.key
string
obligatorio
answers.valueString
string
obligatorio
displayName
string
Cuerpo de la respuesta
answers
array of object
obligatorio
Mostrar atributos secundarios
answers.isDefault
boolean
answers.key
string
obligatorio
answers.valueString
string
obligatorio
businessProfileId
string
The ID of an existing Business Profile.
businessProfileVersion
integer
The version of the Business Profile.
createdAt
string
obligatorio
displayName
string
formId
string
obligatorio
id
string
obligatorio
locale
string
obligatorio
organizationId
string
obligatorio
reviewComment
string
status
string
obligatorio
The status of the form entry.
Possible values: draft, submitted, approved, rejected, expired
tags
array of object
Mostrar atributos secundarios
tags.key
string
obligatorio
tags.value
string
obligatorio
updatedAt
string
obligatorio
Ejemplo de código
curl -X PATCH 'https://api.bird.com/organizations/{organizationId}/kyc-forms/{kycFormId}/entries/{kycFormEntryId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'