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

Queryparameters

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

Antwoord-payload

nextPageToken

string

The token to fetch the next page of results. If empty, there are no more results to fetch.

results

array of object

verplicht

Onderliggende attributen tonen

results.conditions

object

results.countryCode

string

results.createdAt

string

verplicht

results.defaultLocale

string

verplicht

results.gracePeriodDays

integer

results.id

string

verplicht

results.name

string

verplicht

results.questions

array of object

verplicht

Onderliggende attributen tonen

results.questions.locale

string

verplicht

results.questions.questions

array of object

verplicht

Onderliggende attributen tonen

results.questions.questions.conditions

array of object

Onderliggende attributen tonen

results.questions.questions.conditions.key

string

results.questions.questions.conditions.value

string

results.questions.questions.description

string

results.questions.questions.displayName

string

verplicht

results.questions.questions.format

string

verplicht

Possible values: none

results.questions.questions.key

string

verplicht

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

Onderliggende attributen tonen

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

verplicht

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

results.questions.questions.formQuestionConfig

object

Onderliggende attributen tonen

results.questions.questions.formQuestionConfig.stringDatetimeConfig

object

Onderliggende attributen tonen

results.questions.questions.formQuestionConfig.stringDatetimeConfig.allowTimezoneSelectionByUser

boolean

results.questions.questions.formQuestionConfig.stringDatetimeConfig.datetimeRange

object

verplicht

Onderliggende attributen tonen

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

verplicht

Possible values: number, organization, channel

results.status

string

verplicht

Possible values: draft, active, deactivated

results.updatedAt

string

verplicht

Codevoorbeeld

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