DocumentatieEngagement Platform API
Sign inGet started
Guides
API

Get KYC form

GET
/kyc-forms/{kycFormId}
Get KYC form
Antwoord-payload
conditions
object
countryCode
string
createdAt
string
verplicht
defaultLocale
string
verplicht
gracePeriodDays
integer
id
string
verplicht
name
string
verplicht
questions
array of object
verplicht
Onderliggende attributen tonen
questions.locale
string
verplicht
questions.questions
array of object
verplicht
Onderliggende attributen tonen
questions.questions.conditions
array of object
Onderliggende attributen tonen
questions.questions.conditions.key
string
questions.questions.conditions.value
string
questions.questions.description
string
questions.questions.displayName
string
verplicht
questions.questions.format
string
verplicht
Possible values: none
questions.questions.key
string
verplicht
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
Onderliggende attributen tonen
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
verplicht
Possible values: bool, boolArray, intArray, float, floatArray
questions.questions.formQuestionConfig
object
Onderliggende attributen tonen
questions.questions.formQuestionConfig.stringDatetimeConfig
object
Onderliggende attributen tonen
questions.questions.formQuestionConfig.stringDatetimeConfig.allowTimezoneSelectionByUser
boolean
questions.questions.formQuestionConfig.stringDatetimeConfig.datetimeRange
object
verplicht
Onderliggende attributen tonen
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
verplicht
Possible values: number, organization, channel
status
string
verplicht
Possible values: draft, active, deactivated
updatedAt
string
verplicht
Codevoorbeeld
curl -X GET 'https://api.bird.com/kyc-forms/{kycFormId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'