Skip to main content
POST
Create compliance check

Authorizations

Authorization
string
header
required

Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.

Headers

tenant
string
required

Your tenant identifier. Requests without it are rejected.

Body

application/json
searchParams
object
required
entityId
string
required
target
string
required
internalId
string

Internal ID of the individual or organization

tags
string

Tags

data
object

Response

201 - application/json
type
string
required
id
string
required
Pattern: ^check(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
createdAt
string<date-time>
required
entityId
string
required
target
string
required
provider
string
required
searchKey
string
required
alertIds
string[]

Array of alert IDs associated with this check

Pattern: ^alert(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$