Interface KycSessionRequest

Request issued for creating a KYC session. The provided returnUrl will be used to redirect the customer at the end of the flow. If no return url is provided, the default return url will be used.

interface KycSessionRequest {
    language?: string;
    merchantRefNum: string;
    returnUrl?: string;
}

Properties

language? merchantRefNum returnUrl?

Properties

Optional language

language?: string

The language to be used in the KYC Verification session.

Renders content for the merchant customer in the specified language. If not provided, the application will default to 'en'. Supported values are:

  • en-GB
  • cs-CZ
  • de-DE
  • el-GR
  • en-US
  • es-ES
  • es-US
  • fr-FR
  • it-IT
  • ko-KR
  • pl-PL
  • pt-BR
  • pt-PT
  • ru-RU
  • tr-TR
  • zh-CN

merchantRefNum

merchantRefNum: string

This is the merchant reference number created by the merchant and submitted as part of the KYC Verification session request.

Optional returnUrl

returnUrl?: string

The URL to which the customer is redirected after the KYC Verification session is completed. If non is provided, the default URL is used.

Settings

Member Visibility

Theme

On This Page

languagemerchantRefNumreturnUrl