Skip to main content
GET
Get liveness check

Authorizations

X-API-Key
string
header
required

Includes an API key in the HTTP headers to authenticate the client.

X-API-Secret
string
header
required

Includes an API secret in the HTTP headers to authenticate the client.

Path Parameters

id
string
required

A valid Customer ID

Pattern: ^cus_[a-zA-Z0-9]{27}$
Example:

"cus_2ofTA13AD0xBtbEvBl20aEb1hEu"

controlPersonId
string
required

A valid Control Person ID

Pattern: ^ctl_[a-zA-Z0-9]{27}$
Example:

"ctl_2ofTA13AD0xBtbEvBl20aEb1hEu"

Response

Liveness check retrieved successfully

controlPersonId
string
required

A valid Control Person ID

Pattern: ^ctl_[a-zA-Z0-9]{27}$
Example:

"ctl_2ofTA13AD0xBtbEvBl20aEb1hEu"

status
enum<string>
required
Available options:
PENDING,
PASSED,
FAILED,
EXPIRED,
COMPLETED
expirationDate
string
required
verificationUrl
string<uri>