curl --request GET \
--url https://sandbox-api.borderless.xyz/v1/identities/{identityId}/compliance-checks/{slug}/requirements \
--header 'Authorization: Bearer <token>'import requests
url = "https://sandbox-api.borderless.xyz/v1/identities/{identityId}/compliance-checks/{slug}/requirements"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sandbox-api.borderless.xyz/v1/identities/{identityId}/compliance-checks/{slug}/requirements', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox-api.borderless.xyz/v1/identities/{identityId}/compliance-checks/{slug}/requirements",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox-api.borderless.xyz/v1/identities/{identityId}/compliance-checks/{slug}/requirements"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox-api.borderless.xyz/v1/identities/{identityId}/compliance-checks/{slug}/requirements")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.borderless.xyz/v1/identities/{identityId}/compliance-checks/{slug}/requirements")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"slug": "compliance-fee5483c",
"schema": {},
"missingFields": [
"<string>"
],
"requiredDocuments": [
{
"mode": "oneOf",
"documents": [
"Passport"
]
}
],
"ownerRequiredDocuments": [
{
"index": 123,
"personalIdentityId": "<string>",
"requiredDocuments": [
{
"mode": "oneOf",
"documents": [
"Passport"
]
}
]
}
],
"requiredExtras": {
"acceptTermsOfService": {
"link": "<string>",
"redirectUrl": "<string>"
},
"yellowcardCredentials": {
"provided": true,
"valid": true
},
"bitsoCredentials": {
"provided": true,
"valid": true,
"status": {
"current": "active",
"required": "<string>"
},
"verificationLevel": {
"current": 123,
"minimum": 123
}
},
"hercleCredentials": {
"provided": true,
"valid": true
},
"finityCredentials": {
"provided": true,
"valid": true
},
"capaCredentials": {
"provided": true,
"valid": true
}
},
"termsOfService": {
"accepted": true
},
"type": "Bridge_base"
}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>'import requests
url = "https://sandbox-api.borderless.xyz/v1/identities/{identityId}/compliance-checks/{slug}/requirements"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sandbox-api.borderless.xyz/v1/identities/{identityId}/compliance-checks/{slug}/requirements', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox-api.borderless.xyz/v1/identities/{identityId}/compliance-checks/{slug}/requirements",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox-api.borderless.xyz/v1/identities/{identityId}/compliance-checks/{slug}/requirements"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox-api.borderless.xyz/v1/identities/{identityId}/compliance-checks/{slug}/requirements")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.borderless.xyz/v1/identities/{identityId}/compliance-checks/{slug}/requirements")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"slug": "compliance-fee5483c",
"schema": {},
"missingFields": [
"<string>"
],
"requiredDocuments": [
{
"mode": "oneOf",
"documents": [
"Passport"
]
}
],
"ownerRequiredDocuments": [
{
"index": 123,
"personalIdentityId": "<string>",
"requiredDocuments": [
{
"mode": "oneOf",
"documents": [
"Passport"
]
}
]
}
],
"requiredExtras": {
"acceptTermsOfService": {
"link": "<string>",
"redirectUrl": "<string>"
},
"yellowcardCredentials": {
"provided": true,
"valid": true
},
"bitsoCredentials": {
"provided": true,
"valid": true,
"status": {
"current": "active",
"required": "<string>"
},
"verificationLevel": {
"current": 123,
"minimum": 123
}
},
"hercleCredentials": {
"provided": true,
"valid": true
},
"finityCredentials": {
"provided": true,
"valid": true
},
"capaCredentials": {
"provided": true,
"valid": true
}
},
"termsOfService": {
"accepted": true
},
"type": "Bridge_base"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Optional redirect URL after compliance check
Business identity that scopes the compliance check (providers with per-business-identity credentials). Pass the same businessIdentityId used on deposits.
Response
Deprecated. Use type instead. This field is kept for backward compatibility and will be removed in future versions.
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 Show child attributes
Show child attributes
Documents still missing for each beneficial owner of a business identity.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
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 Was this page helpful?