Skip to main content
GET
/
customers
/
{id}
/
control-persons
/
{controlPersonId}
/
liveness
Get liveness check
curl --request GET \
  --url https://api.conduit.financial/customers/{id}/control-persons/{controlPersonId}/liveness \
  --header 'X-API-Key: <api-key>' \
  --header 'X-API-Secret: <api-key>'
{
  "controlPersonId": "ctl_2ofTA13AD0xBtbEvBl20aEb1hEu",
  "status": "PENDING",
  "expirationDate": "<string>",
  "verificationUrl": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.conduit.financial/llms.txt

Use this file to discover all available pages before exploring further.

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>