DocumentationEngagement Platform API
Sign inGet started
Guides
API

List KYC forms

Get a list of the required KYC forms you need to submit to meet a specific country requirements.
GET
/kyc-forms
List KYC forms
Paramètres de requête
limit
integer
Limits the number of results to return.
reverse
boolean
Reverses the order in which the results are returned.
pageToken
string
The cursor that keeps track of the current position in the results.
countryCode
string
Filter KYC forms by target country.
scope
string
Filter KYC forms by scope.
Possible values: number, organization, channel
Corps de la réponse
nextPageToken
string
The token to fetch the next page of results. If empty, there are no more results to fetch.
results
array of object
obligatoire
Afficher les attributs enfants
results.conditions
object
results.countryCode
string
results.createdAt
string
obligatoire
results.defaultLocale
string
obligatoire
results.gracePeriodDays
integer
results.id
string
obligatoire
results.name
string
obligatoire
results.questions
array of object
obligatoire
Afficher les attributs enfants
results.questions.locale
string
obligatoire
results.questions.questions
array of object
obligatoire
Afficher les attributs enfants
results.questions.questions.conditions
array of object
Afficher les attributs enfants
results.questions.questions.conditions.key
string
results.questions.questions.conditions.value
string
results.questions.questions.description
string
results.questions.questions.displayName
string
obligatoire
results.questions.questions.format
string
obligatoire
Possible values: none
results.questions.questions.key
string
obligatoire
results.questions.questions.mapping
string
Map the answer to a contact attribute. If not set, the answer will not be mapped.
results.questions.questions.options
array of object
Afficher les attributs enfants
results.questions.questions.options.key
string
results.questions.questions.options.value
string
results.questions.questions.placeholder
string
results.questions.questions.required
boolean
results.questions.questions.timezone
string
results.questions.questions.type
string
obligatoire
Possible values: bool, boolArray, intArray, float, floatArray
results.questions.questions.formQuestionConfig
object
Afficher les attributs enfants
results.questions.questions.formQuestionConfig.stringDatetimeConfig
object
Afficher les attributs enfants
results.questions.questions.formQuestionConfig.stringDatetimeConfig.allowTimezoneSelectionByUser
boolean
results.questions.questions.formQuestionConfig.stringDatetimeConfig.datetimeRange
object
obligatoire
Afficher les attributs enfants
results.questions.questions.formQuestionConfig.stringDatetimeConfig.datetimeRange.type
string
Possible values: any, future, past
results.questions.questions.formQuestionConfig.stringDatetimeConfig.defaultTimezone
string
results.questions.questions.formQuestionConfig.stringDatetimeConfig.includeTime
boolean
results.questions.questions.formQuestionConfig.stringDatetimeConfig.localeOverride
string
results.questions.questions.formQuestionConfig.stringDatetimeConfig.timeFormat
string
Possible values: am-pm, 24h
results.questions.questions.formQuestionConfig.stringDatetimeConfig.timePlaceholder
string
results.questions.questions.formQuestionConfig.type
string
Possible values: stringDatetime
results.questions.questions.ui:type
string
hint the UI what form to show if type isn't sufficient
Possible values: shortText, longText, dropdown, radio, checkboxSelect
results.scope
string
obligatoire
Possible values: number, organization, channel
results.status
string
obligatoire
Possible values: draft, active, deactivated
results.updatedAt
string
obligatoire
Exemple de code
curl -X GET 'https://api.bird.com/kyc-forms' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'