/
Retrieve a KYC liveness s...

Retrieve a KYC liveness session

Request

Retrieves a KYC liveness session with a specified ID.

Security
CustomerJWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required

ID of the resource.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/storefront/kyc-liveness-sessions/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

KYC liveness session retrieved.

Bodyapplication/json
idstring, <= 50 charactersread-only

ID of the KYC liveness session.

Example:"kyc_liv_01HXBZ0MS1GPS6S34MPQXYT5TZ"
customerIdstring, <= 50 characters(CustomerId)read-onlyrequired

ID of the customer resource.

Example:"cus_0YV7DDSDD1C8DA64KHH2W33CPF"
kycRequestIdstring, <= 50 characters

ID of the KYC request that the liveness session is associated with.

Example:"kyc_req_0YV7JMJ3DBCGRBR7K9D4HVGPP5"
sessionIdstringread-only

Session ID of the KYC liveness session in the third-party service.

Example:"4f6cf35x-2c4y-483z-a0a9-158621f77a21"
statusstringread-only

Status of the session.

Enum ValueDescription
pending

Session is created, but not processed yet. This is a temporary state.

succeeded

Session has succeeded. This is a permanent state.

failed

Session has failed. This is a permanent state.

abandoned

Session was not completed and timed out. This is a permanent state.

referenceImagestring or null, (uri)read-only

URL of the reference image.

Example:"https://app.rebilly.com/static/gateways/Stripe.png"
createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

Response
{
  "id": "kyc_liv_01HXBZ0MS1GPS6S34MPQXYT5TZ",
  "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
  "kycRequestId": "kyc_req_0YV7JMJ3DBCGRBR7K9D4HVGPP5",
  "sessionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  "status": "pending",
  "referenceImage": "https://app.rebilly.com/static/gateways/Stripe.png",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ]
}