Retrieve a compliance link
Retrieve a compliance link by its public ID. Returns the associated user, session token, and the branding template applied to the compliance flow.
Authorizations
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.
Public ID of the compliance link (prefixed with cl_).
"cl_3Kf9dQ2mNpXwZ7bV1aLcs"
Public ID of the user this link belongs to (prefixed with usr_).
"usr_3Kf9dQ2mNpXwZ7bV1aLcs"
INDIVIDUAL, BUSINESS, individual, business "INDIVIDUAL"
Hosted compliance link URL. Returned when generating a link; null when
retrieving an existing link.
"https://dashboard.example.com/sandbox/compliance-link?complianceLinkId=cl_3Kf9dQ2mNpXwZ7bV1aLcs&sessionToken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
Session token authorizing the hosted compliance flow.
"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
Branding and legal template applied to the compliance flow. Populated when
retrieving a compliance link; null when generating one.