DokumentationEngagement Platform API
Sign inGet started
Guides
API

Create KYC form entry

POST
/organizations/{organizationId}/kyc-forms/{kycFormId}/entries
Create KYC Form Entry
Anfrage-Payload
locale
string
erforderlich
answers
array of object
erforderlich
Untergeordnete Parameter anzeigen
answers.isDefault
boolean
answers.key
string
erforderlich
answers.valueString
string
erforderlich
status
string
The status of the form entry.
Possible values: draft, submitted, approved, rejected, expired
displayName
string
Antwort-Payload
answers
array of object
erforderlich
Untergeordnete Attribute anzeigen
answers.isDefault
boolean
answers.key
string
erforderlich
answers.valueString
string
erforderlich
businessProfileId
string
The ID of an existing Business Profile.
businessProfileVersion
integer
The version of the Business Profile.
createdAt
string
erforderlich
displayName
string
formId
string
erforderlich
id
string
erforderlich
locale
string
erforderlich
organizationId
string
erforderlich
reviewComment
string
status
string
erforderlich
The status of the form entry.
Possible values: draft, submitted, approved, rejected, expired
tags
array of object
Untergeordnete Attribute anzeigen
tags.key
string
erforderlich
tags.value
string
erforderlich
updatedAt
string
erforderlich
Codebeispiel
curl -X POST 'https://api.bird.com/organizations/{organizationId}/kyc-forms/{kycFormId}/entries' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'