Get Session by ID
GET/profile/kyc/sessions/:sessionId
Retrieve kyc session by session Id.
Request
Path Parameters
Responses
- 200
- 404
- 500
OK
- application/json
- Schema
- Example (from schema)
- Kyc Session Example
Schema
Possible values: <= 255 characters
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.
It is URL to which users must be redirected after competing the required activities in Paysafe hosted UI.
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
Generated sessionId
Possible values: <= 40 characters
Merchant's Paysafe wallet customer id
Possible values: non-empty
and <= 40 characters
Customer identifier used in Partner system.
Session creation time
Represents RFC 3339, section 5.6 date-time.
Session expiration time
Represents RFC 3339, section 5.6 date-time.
Possible values: [CREATED
, INITIATED
, CANCELLED
, FAILED
, ABANDONED
, EXPIRED
, COMPLETE
]
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.
Redirect URL where the User should be redirected to to complete some action.
{
"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-09-17T12:55:46.907Z",
"expirationTime": "2024-09-17T12:55:46.907Z",
"status": "COMPLETE",
"redirectUrl": "https://some-process.paysafe.com/"
}
{
"merchantRefNum": "oidfjsdkljfh2131",
"returnUrl": "https://some-process.paysafe.com/",
"language": "en",
"id": "2cb56b2749af52d6b257054ef3de03d8b1b07b6020e8e8c7c13139e70670d368",
"customerId": "1003900",
"externalId": "af5c8b52-0afd-4799-85ab-fe659a076932",
"creationTime": "2019-08-24T14:15:22Z",
"expirationTime": "2019-08-24T14:15:22Z",
"status": "COMPLETE",
"redirectUrl": "https://some-process.paysafe.com/"
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
error
object
Additional details about an error
The error code.
A description of the error.
Details of any parameter value errors.
fieldErrors
object[]
Identifies the JSON request field.
The problem associated with the field.
{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
],
"fieldErrors": [
{
"field": "string",
"error": "string"
}
]
}
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
error
object
Additional details about an error
The error code.
A description of the error.
Details of any parameter value errors.
fieldErrors
object[]
Identifies the JSON request field.
The problem associated with the field.
{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
],
"fieldErrors": [
{
"field": "string",
"error": "string"
}
]
}
}