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{
"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>'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{
"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
Source account whose owning business identity scopes the compliance check (providers with per-business-identity credentials). Pass the same account used as sourceAccountId on deposits.
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, compliance-2c7e1a9d, compliance-cc0a4f2b, compliance-3a7e9d1f 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, Demo_base, CrissCross_base, TripleA_base Was this page helpful?
⌘I