Skip to main content
GET
Get a Compliance Check by id

Authorizations

Authorization
string
header
required

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

Path Parameters

identityId
string
required

Query Parameters

country
enum<string>
Available options:
AF,
AL,
DZ,
AS,
AD,
AO,
AI,
AQ,
AG,
AR,
AM,
AW,
AU,
AT,
AZ,
BS,
BH,
BD,
BB,
BY,
BE,
BZ,
BJ,
BM,
BT,
BO,
BQ,
BA,
BW,
BV,
BR,
IO,
BN,
BG,
BF,
BI,
CV,
KH,
CM,
CA,
KY,
CF,
TD,
CL,
CN,
CX,
CC,
CO,
KM,
CD,
CG,
CK,
CR,
HR,
CU,
CW,
CY,
CZ,
CI,
DK,
DJ,
DM,
DO,
EC,
EG,
SV,
GQ,
ER,
EE,
SZ,
ET,
FK,
FO,
FJ,
FI,
FR,
GF,
PF,
TF,
GA,
GM,
GE,
DE,
GH,
GI,
GR,
GL,
GD,
GP,
GU,
GT,
GG,
GN,
GW,
GY,
HT,
HM,
VA,
HN,
HK,
HU,
IS,
IN,
ID,
IR,
IQ,
IE,
IM,
IL,
IT,
JM,
JP,
JE,
JO,
KZ,
KE,
KI,
KP,
KR,
KW,
KG,
LA,
LV,
LB,
LS,
LR,
LY,
LI,
LT,
LU,
MO,
MG,
MW,
MY,
MV,
ML,
MT,
MH,
MQ,
MR,
MU,
YT,
MX,
FM,
MD,
MC,
MN,
ME,
MS,
MA,
MZ,
MM,
NA,
NR,
NP,
NL,
NC,
NZ,
NI,
NE,
NG,
NU,
NF,
MP,
NO,
OM,
PK,
PW,
PS,
PA,
PG,
PY,
PE,
PH,
PN,
PL,
PT,
PR,
QA,
MK,
RO,
RU,
RW,
RE,
BL,
SH,
KN,
LC,
MF,
PM,
VC,
WS,
SM,
ST,
SA,
SN,
RS,
SC,
SL,
SG,
SX,
SK,
SI,
SB,
SO,
ZA,
GS,
SS,
ES,
LK,
SD,
SR,
SJ,
SE,
CH,
SY,
TW,
TJ,
TZ,
TH,
TL,
TG,
TK,
TO,
TT,
TN,
TR,
TM,
TC,
TV,
UG,
UA,
AE,
GB,
UM,
US,
UY,
UZ,
VU,
VE,
VN,
VG,
VI,
WF,
EH,
YE,
ZM,
ZW,
AX,
ZZ
asset
enum<string>
Available options:
POL,
USDT_POLYGON,
USDC_POLYGON,
SBC_POLYGON,
ETH,
USDT_ETHEREUM,
USDC_ETHEREUM,
PYUSD_ETHEREUM,
DAI_ETHEREUM,
SBC_ETHEREUM,
TRX,
USDT_TRON,
SBC_TRON,
ETH_BASE,
USDC_BASE,
USDB_BASE,
EURC_BASE,
SBC_BASE,
ETH_OPTIMISM,
USDT_OPTIMISM,
USDC_OPTIMISM,
BTC,
CELO,
CUSD_CELO,
USDC_CELO,
SBC_CELO,
SOL,
USDC_SOLANA,
USDT_SOLANA,
PYUSD_SOLANA,
USDP_SOLANA,
EURC_SOLANA,
SBC_SOLANA
fiat
enum<string>

Fiat currency identifier supported by the PFI account.

Available options:
USD,
EUR,
BRL,
ARS,
MXN,
COP,
CLP,
PEN,
PYG,
DOP,
UYU,
BOB,
CRC,
GTQ,
BWP,
CDF,
GHS,
KES,
MWK,
NGN,
RWF,
ZAR,
TZS,
UGX,
ZMW,
XOF,
XAF,
AUD,
BDT,
CAD,
INR,
JPY,
NPR,
PKR,
PHP,
SGD,
GBP,
CNY,
HKD,
IDR,
MYR,
KRW,
LKR,
THB,
TRY,
VND,
CZK,
DKK,
NOK,
PLN,
RON,
RSD,
SEK,
CHF,
AED,
SAR,
QAR,
ILS,
EGP,
JOD,
HNL,
JMD,
NZD,
DZD,
GMD,
GNF,
HTG,
MAD,
TND
paymentMethod
enum<string>
Available options:
ACH,
Wire,
Sepa,
Swift,
Card,
MobileMoney,
PIX,
TED,
PSE,
SPEI,
COELSA,
Transfers30,
SPAV,
CCE,
SPI,
LBTR,
SINPE,
Transfer365,
NIP,
GhIPSS,
BankTransfer,
EFT,
RTP,
BECS,
FPS,
IMPS_FIRC,
Breb,
NPSS,
MADA,
ZAHAV,
IBFT,
SIC
type
enum<string>
Available options:
Deposit,
Withdrawal,
VirtualAccount,
Exchange
sourceAccountId
string

Source account whose owning business identity scopes the compliance checks (providers with per-business-identity credentials). Same account passed as sourceAccountId on deposits.

Required string length: 25

Response

Successfully retrieved 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
incorporatedTypes
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
incorporates
enum<string>[]
required
deprecated

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

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
coverage
object[]
required
deprecated

Deprecated. Use network for the hierarchical shape.

network
object[]
required

Hierarchical view of options accessible under this compliance type — same shape as GET /v1/organizations/network. Prefer this over coverage.

schema
object
required
documents
object[]
required
id
string
required
deprecated

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

kycStatus
enum<string>
required
deprecated

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
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
incompleteReasons
string[] | null
required

Reasons of Incomplete status from PFI. List of missed identity data;

metadata
object
required
canResync
boolean
required

Whether the approved identity can be re-synced to the provider after an edit. True only for providers that support pushing identity updates and when the check is approved.

canDelete
boolean
required

Whether this compliance's customer can be deleted at the provider. True only for providers that support customer deletion and when a provider customer exists.

rejectionReasons
object[] | null
required

Reasons of Rejected status from PFI.

businessIdentityId
string | null

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