Skip to main content
GET
Retrieve a compliance link

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

Public ID of the compliance link (prefixed with cl_)

Response

Compliance link retrieved successfully.

A compliance link.

id
string

Public ID of the compliance link (prefixed with cl_).

Example:

"cl_3Kf9dQ2mNpXwZ7bV1aLcs"

userId
string

Public ID of the user this link belongs to (prefixed with usr_).

Example:

"usr_3Kf9dQ2mNpXwZ7bV1aLcs"

userType
enum<string>
Available options:
INDIVIDUAL,
BUSINESS,
individual,
business
Example:

"INDIVIDUAL"

url
string | null

Hosted compliance link URL. Returned when generating a link; null when retrieving an existing link.

Example:

"https://dashboard.example.com/sandbox/compliance-link?complianceLinkId=cl_3Kf9dQ2mNpXwZ7bV1aLcs&sessionToken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

sessionToken
string

Session token authorizing the hosted compliance flow.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

template
object | null

Branding and legal template applied to the compliance flow. Populated when retrieving a compliance link; null when generating one.