Skip to main content
POST
/
compliance
/
checks
Create compliance check
curl --request POST \
  --url https://api.example.com/compliance/checks \
  --header 'Content-Type: application/json' \
  --data '
{
  "searchParams": {},
  "entityId": "<string>",
  "target": "<string>",
  "internalId": "<string>",
  "tags": "<string>"
}
'
{
  "type": "<string>",
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "entityId": "<string>",
  "target": "<string>",
  "provider": "<string>",
  "searchKey": "<string>",
  "alertIds": [
    "<string>"
  ]
}

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

200 - application/json
​
type
string
required
​
id
string
required
​
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