Skip to main content
POST
/
v1
/
identities
/
{identityId}
/
compliance-checks
/
{slug}
Create a new Compliance Check
curl --request POST \
  --url https://sandbox-api.borderless.xyz/v1/identities/{identityId}/compliance-checks/{slug} \
  --header 'Authorization: Bearer <token>'
{
  "slug": "compliance-fee5483c",
  "status": "NotStarted",
  "metadata": {}
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

identityId
string
required
slug
string
required

Response

Successfully created Compliance Check data.

slug
enum<string>
required
Available options:
compliance-fee5483c,
compliance-3d0947c0,
compliance-9f5059c4,
compliance-4a8e9f3b,
compliance-7b9d2c6a,
compliance-de8e1920
status
enum<string>
required

Deprecated. Use status instead. This field is kept for backward compatibility and will be removed in future versions.

Available options:
NotStarted,
Started,
Incomplete,
AwaitingUbo,
UnderReview,
Rejected,
PreApproved,
Approved,
Cancelled
metadata
object
required