Get KYC form

GET

/kyc-forms/{kycFormId}

Get KYC form

响应载荷

conditions

object

countryCode

string

createdAt

string

必填

defaultLocale

string

必填

gracePeriodDays

integer

string

必填

name

string

必填

questions

array of object

必填

显示子属性

questions.locale

string

必填

questions.questions

array of object

必填

显示子属性

questions.questions.conditions

array of object

显示子属性

questions.questions.conditions.key

string

questions.questions.conditions.value

string

questions.questions.description

string

questions.questions.displayName

string

必填

questions.questions.format

string

必填

Possible values: none

questions.questions.key

string

必填

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

显示子属性

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

必填

Possible values: bool, boolArray, intArray, float, floatArray

questions.questions.formQuestionConfig

object

显示子属性

questions.questions.formQuestionConfig.stringDatetimeConfig

object

显示子属性

questions.questions.formQuestionConfig.stringDatetimeConfig.allowTimezoneSelectionByUser

boolean

questions.questions.formQuestionConfig.stringDatetimeConfig.datetimeRange

object

必填

显示子属性

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

必填

Possible values: number, organization, channel

status

string

必填

Possible values: draft, active, deactivated

updatedAt

string

必填

代码示例

curl -X GET 'https://api.bird.com/kyc-forms/{kycFormId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'