Skip to main content
GET
Get compliance requirements for a compliance

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

redirectUrl
string

Optional redirect URL after compliance check

businessIdentityId
string

Business identity that scopes the compliance check (providers with per-business-identity credentials). Pass the same businessIdentityId used on deposits.

Response

200 - application/json
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,
compliance-90c1f7d5,
compliance-b8685d03,
compliance-6b41c8e2,
compliance-7e2a9c15,
compliance-5d8f31c7
schema
object
required
missingFields
string[]
required
requiredDocuments
object[]
required
ownerRequiredDocuments
object[]
required

Documents still missing for each beneficial owner of a business identity.

requiredExtras
object
required
termsOfService
object | null
required

The provider's terms of service for this identity, accepted or not. Null when the provider has no terms step. While they are not accepted, the link to accept them is in requiredExtras.acceptTermsOfService.

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,
BlindPay_va,
Finity_base,
Ares_base,
Hercle_base,
Infinia_base,
Walapay_base,
Yativo_base,
Capa_base,
Bivo_base,
Cobre_base,
Brale_base,
Onmeta_base,
Onmeta_ind,
Alfred_base,
Tazapay_base,
Demo_base,
CrissCross_base,
CrissCross_kenya,
TripleA_base,
Pockyt_base,
TripleA_enhanced