Skip to main content
POST
/
simulator
/
compliance
Simulate Compliance
curl --request POST \
  --url https://api.conduit.financial/simulator/compliance \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-API-Secret: <api-key>' \
  --data '
{
  "type": "counterparty",
  "id": "cp_2ofTA13AD0xBtbEvBl20aEb1hEu",
  "status": "active"
}
'
{}

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