DocumentazioneEngagement Platform API
Sign inGet started
Guides
API

Update KYC form entry

PATCH
/organizations/{organizationId}/kyc-forms/{kycFormId}/entries/{kycFormEntryId}
Update KYC Form Entry
Payload della richiesta
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
Mostra parametri secondari
answers.isDefault
boolean
answers.key
string
obbligatorio
answers.valueString
string
obbligatorio
displayName
string
Payload della risposta
answers
array of object
obbligatorio
Mostra attributi secondari
answers.isDefault
boolean
answers.key
string
obbligatorio
answers.valueString
string
obbligatorio
businessProfileId
string
The ID of an existing Business Profile.
businessProfileVersion
integer
The version of the Business Profile.
createdAt
string
obbligatorio
displayName
string
formId
string
obbligatorio
id
string
obbligatorio
locale
string
obbligatorio
organizationId
string
obbligatorio
reviewComment
string
status
string
obbligatorio
The status of the form entry.
Possible values: draft, submitted, approved, rejected, expired
tags
array of object
Mostra attributi secondari
tags.key
string
obbligatorio
tags.value
string
obbligatorio
updatedAt
string
obbligatorio
Esempio di codice
curl -X PATCH 'https://api.bird.com/organizations/{organizationId}/kyc-forms/{kycFormId}/entries/{kycFormEntryId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'