Interface KycSession

KYC session.

interface KycSession {
    creationTime: string;
    customerId: string;
    expirationTime: string;
    externalId: string;
    id: string;
    language?: string;
    merchantRefNum: string;
    redirectUrl: string;
    returnUrl: string;
    status: KycSessionStatus;
}

Properties

creationTime customerId expirationTime externalId id language? merchantRefNum redirectUrl returnUrl status

Properties

creationTime

creationTime: string

Date and time when the KYC Verification session was created.

Format should be ISO 8601 in UTC. Represents RFC 3339, section 5.6 date-time.

Example

"2024-05-08T14:43:33Z"

customerId

customerId: string

Wallet customer identifier.

expirationTime

expirationTime: string

Expiration time of the KYC Verification session.

Format should be ISO 8601 in UTC. Represents RFC 3339, section 5.6 date-time.

Example

"2024-05-08T14:43:33Z"

externalId

externalId: string

Customer identifier used in Partner system.

id

id: string

The kyc session ID.

Optional language

language?: string

The language to be used in the KYC Verification session.

merchantRefNum

merchantRefNum: string

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

redirectUrl

redirectUrl: string

Redirect URL where the User should be redirected to begin the KYC Verification session.

returnUrl

returnUrl: string

The URL to which the customer is redirected after the KYC Verification session is completed.

status

status: KycSessionStatus

The status of the KYC Verification session.

Settings

Member Visibility

Theme

On This Page

creationTimecustomerIdexpirationTimeexternalIdidlanguagemerchantRefNumredirectUrlreturnUrlstatus