Skip to main content
POST
Create a new Compliance Check

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

Query Parameters

sourceAccountId
string

Source account whose owning business identity scopes the compliance check (providers with per-business-identity credentials). Pass the same account used as sourceAccountId on deposits.

Response

Successfully created Compliance Check data.

type
enum<string>
required
Available options:
Bridge_base,
Bridge_sepa,
Koywe_base,
Kotanipay_base,
Bitso_base,
Yellowcard_base,
TraceFinance_base,
HoneyCoin_base,
BlindPay_base,
BlindPay_enhanced,
Finity_base,
Ares_base,
Hercle_base,
Infinia_base,
Walapay_base,
Yativo_base,
Capa_base,
Bivo_base,
Cobre_base,
Brale_base,
Juicyway_base,
Onmeta_base,
Onmeta_ind,
Alfred_base,
Demo_base,
CrissCross_base,
TripleA_base
slug
enum<string>
required
deprecated

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

Available options:
compliance-fee5483c,
compliance-3d0947c0,
compliance-9f5059c4,
compliance-4a8e9f3b,
compliance-7b9d2c6a,
compliance-de8e1920,
compliance-t7f4b831,
compliance-h9x7p245,
compliance-432704,
compliance-15bc9ec4,
compliance-a96ad46a,
compliance-4c347d0a,
compliance-ff6f0b66,
compliance-bbd0abdf,
compliance-d4a0bea2,
compliance-ce1ef04d,
compliance-191335b3,
compliance-f47aa1e0,
compliance-b92f0ad3,
compliance-f44d3582,
compliance-5402f18a,
compliance-dbd2a55c,
compliance-2c7e1a9d,
compliance-cc0a4f2b,
compliance-3a7e9d1f
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
businessIdentityId
string | null

Business identity whose provider credentials performed the screening. Null for organization-scoped checks.