Get compliance requirements for a compliance
curl --request GET \
--url https://sandbox-api.borderless.xyz/v1/identities/{identityId}/compliance-checks/{slug}/requirements \
--header 'Authorization: Bearer <token>'{
"schema": {},
"missingFields": [
"<string>"
],
"requiredDocuments": [
{
"documents": []
}
],
"requiredExtras": {
"acceptTermsOfService": {
"link": "<string>",
"redirectUrl": "<string>"
},
"yellowcardCredentials": {
"provided": true,
"valid": true
},
"bitsoCredentials": {
"provided": true,
"valid": true,
"status": {
"current": "<string>",
"required": "<string>"
},
"verificationLevel": {
"current": 123,
"minimum": 123
}
},
"hercleCredentials": {
"provided": true,
"valid": true
},
"finityCredentials": {
"provided": true,
"valid": true
},
"capaCredentials": {
"provided": true,
"valid": true
}
}
}Compliance Checks
Get compliance requirements for a compliance
GET
/
v1
/
identities
/
{identityId}
/
compliance-checks
/
{slug}
/
requirements
Get compliance requirements for a compliance
curl --request GET \
--url https://sandbox-api.borderless.xyz/v1/identities/{identityId}/compliance-checks/{slug}/requirements \
--header 'Authorization: Bearer <token>'{
"schema": {},
"missingFields": [
"<string>"
],
"requiredDocuments": [
{
"documents": []
}
],
"requiredExtras": {
"acceptTermsOfService": {
"link": "<string>",
"redirectUrl": "<string>"
},
"yellowcardCredentials": {
"provided": true,
"valid": true
},
"bitsoCredentials": {
"provided": true,
"valid": true,
"status": {
"current": "<string>",
"required": "<string>"
},
"verificationLevel": {
"current": 123,
"minimum": 123
}
},
"hercleCredentials": {
"provided": true,
"valid": true
},
"finityCredentials": {
"provided": true,
"valid": true
},
"capaCredentials": {
"provided": true,
"valid": true
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Optional redirect URL after compliance check
Response
200 - application/json
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 Show child attributes
Show child attributes
Show child attributes
Show child attributes
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 Was this page helpful?
⌘I