Get Onboarding Settings
curl --request GET \
--url https://adhere-api.smartcomply.com/api/onboarding/settings \
--header 'x-access-token: <api-key>'import requests
url = "https://adhere-api.smartcomply.com/api/onboarding/settings"
headers = {"x-access-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-access-token': '<api-key>'}};
fetch('https://adhere-api.smartcomply.com/api/onboarding/settings', 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://adhere-api.smartcomply.com/api/onboarding/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-access-token: <api-key>"
],
]);
$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://adhere-api.smartcomply.com/api/onboarding/settings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-access-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://adhere-api.smartcomply.com/api/onboarding/settings")
.header("x-access-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://adhere-api.smartcomply.com/api/onboarding/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-access-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "failed",
"message": "Authentication credentials were not provided."
}Customer Onboarding
Get Onboarding Settings
Retrieve the current identity verification and AML screening settings for your branch.
GET
/
api
/
onboarding
/
settings
Get Onboarding Settings
curl --request GET \
--url https://adhere-api.smartcomply.com/api/onboarding/settings \
--header 'x-access-token: <api-key>'import requests
url = "https://adhere-api.smartcomply.com/api/onboarding/settings"
headers = {"x-access-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-access-token': '<api-key>'}};
fetch('https://adhere-api.smartcomply.com/api/onboarding/settings', 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://adhere-api.smartcomply.com/api/onboarding/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-access-token: <api-key>"
],
]);
$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://adhere-api.smartcomply.com/api/onboarding/settings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-access-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://adhere-api.smartcomply.com/api/onboarding/settings")
.header("x-access-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://adhere-api.smartcomply.com/api/onboarding/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-access-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "failed",
"message": "Authentication credentials were not provided."
}Endpoint
GET /api/onboarding/settings
Request
Headers
| Header | Value | Required |
|---|---|---|
x-access-token | Your API key | Yes |
Example
curl https://adhere-api.smartcomply.com/api/onboarding/settings \
-H "x-access-token: YOUR_API_KEY"
import requests
response = requests.get(
"https://adhere-api.smartcomply.com/api/onboarding/settings",
headers={"x-access-token": "YOUR_API_KEY"},
)
print(response.json())
const response = await fetch("https://adhere-api.smartcomply.com/api/onboarding/settings", {
headers: { "x-access-token": "YOUR_API_KEY" },
});
const data = await response.json();
Response
"success" on a successful request."Settings retrieved"200 OK
{
"status": "success",
"message": "Settings retrieved",
"data": {
"ivs": true,
"aml": true
}
}
Error Responses
| HTTP Status | Message | Cause |
|---|---|---|
401 | "Authorization token is missing" | No x-access-token header |
401 | "Authorization failed" | Token not recognised or expired |
Authorizations
Your Adhere API secret key
Response
Settings retrieved
⌘I

