Get all customer sessions

GET 
/kyc/customers/:customerId/sessions

Retrieve all customer sessions

Request

Path Parameters

customerId stringrequired

Merchant's Paysafe wallet customer id

Query Parameters

limit integer

Possible values: >= 1 and <= 50

Default value: 10

This is the requested number of records to return. Max = 50. Default = 10.

offset integer

Default value: 0

This is the requested starting position of the response entries, where 0 is the first record. Default = 0.

Responses

200

OK

application/json

Schema

Schema

sessions object[]

meta

object

Contains paging information regarding the returned records, when response is paginated.

The input for paginated query contains two parameters:

• limit - This is the requested number of records to return. Defaults to 10 and maximum is 50.
• offset - This is the requested starting position of the response, where 0 is the first record. Default = 0.

Note! The total number of records is not returned, to prevent queries spanning on all records. If numberOfRecords<limit, this means no further pages are available. On request of offset beyond the last record, the returned numberOfRecords is 0.

The number of previous pages can be calculated by dividing offset to limit.

numberOfRecords integer

This is the number of records returned in the lookup. Always numberOfRecords is smaller than or equal to limit.

limit integer

This is the requested number of records to be returned per page.

offset integer

This is the requested starting position of the response, where 0 is the first record.

page integer

This is the page of records on which the lookup starts. The starting page is 1.

Example (from schema)

{
  "sessions": [
    {
      "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-11-12T16:34:38.761Z",
      "expirationTime": "2024-11-12T16:34:38.761Z",
      "status": "COMPLETE",
      "redirectUrl": "https://some-process.paysafe.com/",
      "sessionEvents": [
        {
          "name": "BIOMETRIC_CONSENT",
          "kycProviderDetails": {
            "kycProvider": "string"
          }
        }
      ],
      "verificationDocuments": [
        {
          "category": "IDENTITY",
          "type": "ID_CARD",
          "subtype": "VISA",
          "status": "APPROVED",
          "statusReason": "BLURRY",
          "attributes": {
            "firstName": "string",
            "lastName": "string",
            "dob": "string",
            "addressLine": "string",
            "country": "string",
            "city": "string",
            "postalCode": "string",
            "issuingCountry": "string",
            "issueDate": "string",
            "documentExpiry": "string",
            "subdivision": "string",
            "faceMatch": true
          },
          "kycProviderDetails": {
            "kycProvider": "string"
          }
        }
      ],
      "electronicVerifications": [
        {
          "kycProviderDetails": {
            "kycProvider": "string"
          },
          "results": [
            {
              "name": "ID_MATCH",
              "value": "VALID"
            }
          ]
        }
      ]
    }
  ],
  "meta": {
    "numberOfRecords": 1,
    "limit": 10,
    "offset": 0,
    "page": 1
  }
}

Get Kyc Sessions

{
  "sessions": [
    {
      "merchantRefNum": "wqeasdas21312weq",
      "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",
      "sessionEvents": [
        {
          "name": "BIOMETRIC_CONSENT"
        }
      ],
      "verificationDocuments": [
        {
          "category": "IDENTITY",
          "type": "ID_CARD",
          "subtype": "RESIDENT_PERMIT_ID",
          "status": "APPROVED",
          "statusReason": "BLURRY",
          "attributes": {
            "firstName": "John",
            "lastName": "Smith",
            "dob": "1980-01-27",
            "addressLine": "Johnson street, nr 23",
            "country": "ARG",
            "city": "Peru",
            "postalCode": "21332",
            "issuingCountry": "ARG",
            "issueDate": "2020-11-26",
            "documentExpiry": "2027-11-26",
            "subdivision": "Peru",
            "faceMatch": true
          },
          "kycProviderDetails": {
            "kycProvider": "Jumio"
          }
        }
      ],
      "electronicVerifications": [
        {
          "kycProviderDetails": {
            "kycProvider": "Idology"
          },
          "results": [
            {
              "name": "ID_MATCH",
              "value": "VALID"
            }
          ]
        }
      ]
    }
  ],
  "meta": {
    "numberOfRecords": 1,
    "limit": 0,
    "page": 0
  }
}

Loading...