DocumentatieEngagement Platform API
Sign inGet started
Guides
API

Update KYC form entry

PATCH
/organizations/{organizationId}/kyc-forms/{kycFormId}/entries/{kycFormEntryId}
Update KYC Form Entry
Verzoek-payload
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
Onderliggende parameters tonen
answers.isDefault
boolean
answers.key
string
verplicht
answers.valueString
string
verplicht
displayName
string
Antwoord-payload
answers
array of object
verplicht
Onderliggende attributen tonen
answers.isDefault
boolean
answers.key
string
verplicht
answers.valueString
string
verplicht
businessProfileId
string
The ID of an existing Business Profile.
businessProfileVersion
integer
The version of the Business Profile.
createdAt
string
verplicht
displayName
string
formId
string
verplicht
id
string
verplicht
locale
string
verplicht
organizationId
string
verplicht
reviewComment
string
status
string
verplicht
The status of the form entry.
Possible values: draft, submitted, approved, rejected, expired
tags
array of object
Onderliggende attributen tonen
tags.key
string
verplicht
tags.value
string
verplicht
updatedAt
string
verplicht
Codevoorbeeld
curl -X PATCH 'https://api.bird.com/organizations/{organizationId}/kyc-forms/{kycFormId}/entries/{kycFormEntryId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'