Skip to main content
PUT
Create, enable, or disable a regulatory policy

Authorizations

X-API-KEY
string
header
required

Authorization method required to allow user to access the api endpoints.

Body

application/json
policy
enum<string>
required
Available options:
cadoc-5710,
cadoc-5711
Example:

"cadoc-5711"

enabled
boolean
required

Set false to pause the policy without deleting it.

Example:

true

email
string<email>

Recipient of the policy report emails. Required when creating the subscription; omit on update to keep the stored recipient.

Example:

"compliance@example.com"

cnpj
string

CNPJ base of the reporting institution (8 alphanumeric characters). Fills the CADOC XML cnpj header. Required when creating a subscription; omit on a later update to keep the stored value.

Example:

"99999999"

Response

200 - application/json
policy
enum<string>
required
Available options:
cadoc-5710,
cadoc-5711
Example:

"cadoc-5711"

pretty_name
string
required
Example:

"CADOC 5711 - Daily custody filing"

email
string
required
Example:

"compliance@example.com"

enabled
boolean
required
Example:

true

created_at
string
required
Example:

"2026-08-25T00:00:00.000Z"

updated_at
string
required
Example:

"2026-08-25T00:00:00.000Z"

cnpj
string | null
Example:

"99999999"

Last modified on September 3, 2026