Skip to main content
POST
/
v1
/
identities
/
{id}
/
compliance-checks
Start a compliance check
curl --request POST \
  --url https://sandbox-api.borderless.xyz/v1/identities/{id}/compliance-checks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "country": "US",
  "operationType": "Deposit"
}
'
{
  "id": "<string>",
  "kycStatus": "NotStarted",
  "status": "NotStarted",
  "metadata": {},
  "coverage": [
    {
      "country": "AF",
      "operationType": "Deposit"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Body

application/json
​
country
enum<string>
required

The country code in ISO-3166-2 format where the identity intends to operate. See ISO-3166-2 documentation.

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
Example:

"US"

​
operationType
enum<string>
required

The type of operation the identity intends to perform: Withdrawal or Deposit.

Available options:
Deposit,
Withdrawal
Example:

"Deposit"

Response

Successfully created Compliance check data.

​
id
string
required
​
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
​
metadata
object
required
​
coverage
object[]
required