KYB Token

Generate KYB form token

post/kyb/tokens/

Request

Base URL
https://ivs.idenfy.com
Auth
HTTP basic
TypeScript
https://skmtc.dev/idenfy/apis/idenfy-ivs-core-api/docs/kyb/tokens/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

tokenType'FORM' | 'GOV1' | 'GOV2' required

lifetimeinteger

The duration in seconds of KYB token validity.

clientIdstring required

A unique string identifying a client on your side.

externalRefstring nullable

Any additional value chosen by you.

locale'en' | 'es' | 'fr' | 'ru' | 'de' | 'it' | 'pl' | 'lt' | 'lv' | 'et' | 'cs' | 'ro' | 'hu' | 'ja' | 'bg' | 'nl' | 'pt'

flowstring uuid nullable

KYB flow's id to use for this KYB session.

themestring uuid nullable

KYB theme's id to use for this KYB session.

questionnairestring nullable

KYB questionnaire's key to use for this KYB session. null for no questionnaire. If not given, the default questionnaire (from your KYB settings) will be used. Ignored when KYB flow is used, then questionnaire is taken according to used flow.

questionnaireRequiredboolean

If KYB session should have a questionnaire.

tagsstring[]

List of case-sensitive strings. Each tag can not be longer than 32 characters.

scanRefsstring[] nullable

Response

tokenType'FORM' | 'GOV1' | 'GOV2' required

tokenStringstring required

Token string used for authentication.

expirationstring date-time required

Date and time when this token will become expired.

isActiveboolean required

Indicates whether this token is not deactivated.

isValidboolean required

Indicates whether this token is valid.

companyIdstring nullable required