DocumentaciónEngagement Platform API
Sign inGet started
Guides
API

List KYC form entries

GET
/organizations/{organizationId}/kyc-forms/{kycFormId}/entries
List KYC Form Entries by OrganizationID
Cuerpo de la respuesta
results
array of object
obligatorio
Mostrar atributos secundarios
results.answers
array of object
obligatorio
Mostrar atributos secundarios
results.answers.isDefault
boolean
results.answers.key
string
obligatorio
results.answers.valueString
string
obligatorio
results.businessProfileId
string
The ID of an existing Business Profile.
results.businessProfileVersion
integer
The version of the Business Profile.
results.createdAt
string
obligatorio
results.displayName
string
results.formId
string
obligatorio
results.id
string
obligatorio
results.locale
string
obligatorio
results.organizationId
string
obligatorio
results.reviewComment
string
results.status
string
obligatorio
The status of the form entry.
Possible values: draft, submitted, approved, rejected, expired
results.tags
array of object
Mostrar atributos secundarios
results.tags.key
string
obligatorio
results.tags.value
string
obligatorio
results.updatedAt
string
obligatorio
Ejemplo de código
curl -X GET 'https://api.bird.com/organizations/{organizationId}/kyc-forms/{kycFormId}/entries' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'