Get KYC form

GET

/kyc-forms/{kycFormId}

Get KYC form

Treść odpowiedzi

conditions

object

countryCode

string

createdAt

string

wymagane

defaultLocale

string

wymagane

gracePeriodDays

integer

string

wymagane

name

string

wymagane

questions

array of object

wymagane

Pokaż atrybuty podrzędne

questions.locale

string

wymagane

questions.questions

array of object

wymagane

Pokaż atrybuty podrzędne

questions.questions.conditions

array of object

Pokaż atrybuty podrzędne

questions.questions.conditions.key

string

questions.questions.conditions.value

string

questions.questions.description

string

questions.questions.displayName

string

wymagane

questions.questions.format

string

wymagane

Possible values: none

questions.questions.key

string

wymagane

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

Pokaż atrybuty podrzędne

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

wymagane

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

questions.questions.formQuestionConfig

object

Pokaż atrybuty podrzędne

questions.questions.formQuestionConfig.stringDatetimeConfig

object

Pokaż atrybuty podrzędne

questions.questions.formQuestionConfig.stringDatetimeConfig.allowTimezoneSelectionByUser

boolean

questions.questions.formQuestionConfig.stringDatetimeConfig.datetimeRange

object

wymagane

Pokaż atrybuty podrzędne

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

wymagane

Possible values: number, organization, channel

status

string

wymagane

Possible values: draft, active, deactivated

updatedAt

string

wymagane

Przykład kodu

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