Skip to main content

KycSession

KYC Session model.

merchantRefNumMerchantReferenceNumber (string)required

This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request and allows cross referencing objects from merchant system to embedded wallet objects.

Possible values: <= 255 characters

Example: 4bc2deb3-9766-4598-a08e-a98b60615936
returnUrlurl

The return URL to which users must be redirected after competing the required activities in Paysafe hosted UI.

Example: https://some-process.paysafe.com/
languagestring

Renders content for the merchant customer in the specified language. If not provided, the application will default to 'en'. Supported values are:
en
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

Example: en
idstring

Generated sessionId

Example: 2cb56b2749af52d6b257054ef3de03d8b1b07b6020e8e8c7c13139e70670d368
customerIdstring

Merchant's Paysafe wallet customer id

Possible values: <= 40 characters

Example: 1003900
externalIdExternalId (string)

Customer identifier used in Partner system.

Possible values: non-empty and <= 40 characters

Example: af5c8b52-0afd-4799-85ab-fe659a076932
creationTimedate-time

Session creation time
Represents RFC 3339, section 5.6 date-time.

expirationTimedate-time

Session expiration time
Represents RFC 3339, section 5.6 date-time.

statusKycSessionStatus (string)

CREATED: Initial status given upon session creation.
INITIATED: Once the end customer exchanges their code and enters the KYC flow
COMPLETE: Customer successfully completes their session.
CANCELLED: Customer has decided not to complete their session.
ABANDONED: Customer has not started the KYC flow after session creation.
EXPIRED: Customer did not complete their verification in time and their session has expired.

Possible values: [CREATED, INITIATED, CANCELLED, FAILED, ABANDONED, EXPIRED, COMPLETE]

Example: COMPLETE
redirectUrlurl

Redirect URL where the user should be redirected to in order to complete some action.

Example: https://some-process.paysafe.com/
KycSession
{
  "merchantRefNum": "4bc2deb3-9766-4598-a08e-a98b60615936",
  "returnUrl": "https://some-process.paysafe.com/",
  "language": "en",
  "id": "2cb56b2749af52d6b257054ef3de03d8b1b07b6020e8e8c7c13139e70670d368",
  "customerId": "1003900",
  "externalId": "af5c8b52-0afd-4799-85ab-fe659a076932",
  "creationTime": "2024-07-29T15:51:28.071Z",
  "expirationTime": "2024-07-29T15:51:28.071Z",
  "status": "COMPLETE",
  "redirectUrl": "https://some-process.paysafe.com/"
}