DocumentationEngagement Platform API
Sign inGet started
Guides
API

Create KYC form entry

POST
/organizations/{organizationId}/kyc-forms/{kycFormId}/entries
Create KYC Form Entry
Corps de la requête
locale
string
obligatoire
answers
array of object
obligatoire
Afficher les paramètres enfants
answers.isDefault
boolean
answers.key
string
obligatoire
answers.valueString
string
obligatoire
status
string
The status of the form entry.
Possible values: draft, submitted, approved, rejected, expired
displayName
string
Corps de la réponse
answers
array of object
obligatoire
Afficher les attributs enfants
answers.isDefault
boolean
answers.key
string
obligatoire
answers.valueString
string
obligatoire
businessProfileId
string
The ID of an existing Business Profile.
businessProfileVersion
integer
The version of the Business Profile.
createdAt
string
obligatoire
displayName
string
formId
string
obligatoire
id
string
obligatoire
locale
string
obligatoire
organizationId
string
obligatoire
reviewComment
string
status
string
obligatoire
The status of the form entry.
Possible values: draft, submitted, approved, rejected, expired
tags
array of object
Afficher les attributs enfants
tags.key
string
obligatoire
tags.value
string
obligatoire
updatedAt
string
obligatoire
Exemple de code
curl -X POST 'https://api.bird.com/organizations/{organizationId}/kyc-forms/{kycFormId}/entries' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'