DocumentationEngagement Platform API
Sign inGet started
Guides
API

List KYC form entries

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