DocumentationEngagement Platform API
Sign inGet started
Guides
API

Get KYC form

GET
/kyc-forms/{kycFormId}
Get KYC form
Corps de la réponse
conditions
object
countryCode
string
createdAt
string
obligatoire
defaultLocale
string
obligatoire
gracePeriodDays
integer
id
string
obligatoire
name
string
obligatoire
questions
array of object
obligatoire
Afficher les attributs enfants
questions.locale
string
obligatoire
questions.questions
array of object
obligatoire
Afficher les attributs enfants
questions.questions.conditions
array of object
Afficher les attributs enfants
questions.questions.conditions.key
string
questions.questions.conditions.value
string
questions.questions.description
string
questions.questions.displayName
string
obligatoire
questions.questions.format
string
obligatoire
Possible values: none
questions.questions.key
string
obligatoire
questions.questions.mapping
string
Map the answer to a contact attribute. If not set, the answer will not be mapped.
questions.questions.options
array of object
Afficher les attributs enfants
questions.questions.options.key
string
questions.questions.options.value
string
questions.questions.placeholder
string
questions.questions.required
boolean
questions.questions.timezone
string
questions.questions.type
string
obligatoire
Possible values: bool, boolArray, intArray, float, floatArray
questions.questions.formQuestionConfig
object
Afficher les attributs enfants
questions.questions.formQuestionConfig.stringDatetimeConfig
object
Afficher les attributs enfants
questions.questions.formQuestionConfig.stringDatetimeConfig.allowTimezoneSelectionByUser
boolean
questions.questions.formQuestionConfig.stringDatetimeConfig.datetimeRange
object
obligatoire
Afficher les attributs enfants
questions.questions.formQuestionConfig.stringDatetimeConfig.datetimeRange.type
string
Possible values: any, future, past
questions.questions.formQuestionConfig.stringDatetimeConfig.defaultTimezone
string
questions.questions.formQuestionConfig.stringDatetimeConfig.includeTime
boolean
questions.questions.formQuestionConfig.stringDatetimeConfig.localeOverride
string
questions.questions.formQuestionConfig.stringDatetimeConfig.timeFormat
string
Possible values: am-pm, 24h
questions.questions.formQuestionConfig.stringDatetimeConfig.timePlaceholder
string
questions.questions.formQuestionConfig.type
string
Possible values: stringDatetime
questions.questions.ui:type
string
hint the UI what form to show if type isn't sufficient
Possible values: shortText, longText, dropdown, radio, checkboxSelect
scope
string
obligatoire
Possible values: number, organization, channel
status
string
obligatoire
Possible values: draft, active, deactivated
updatedAt
string
obligatoire
Exemple de code
curl -X GET 'https://api.bird.com/kyc-forms/{kycFormId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'