Skip to main content
POST
Simulate Compliance

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.

Body

application/json
type
enum<string>
required
Available options:
counterparty
id
string
required

A valid Counterparty ID

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

"cp_2ofTA13AD0xBtbEvBl20aEb1hEu"

status
enum<string>
required
Available options:
active,
deleted,
in_compliance_review,
compliance_rejected

Response

Response

success
enum<boolean>
required
Available options:
true