Update Onboarding Settings
curl --request POST \
--url https://adhere-api.smartcomply.com/api/onboarding/settings \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"ivs": true,
"aml": true
}
'import requests
url = "https://adhere-api.smartcomply.com/api/onboarding/settings"
payload = {
"ivs": True,
"aml": True
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({ivs: true, aml: true})
};
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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'ivs' => true,
'aml' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://adhere-api.smartcomply.com/api/onboarding/settings"
payload := strings.NewReader("{\n \"ivs\": true,\n \"aml\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://adhere-api.smartcomply.com/api/onboarding/settings")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"ivs\": true,\n \"aml\": true\n}")
.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::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ivs\": true,\n \"aml\": true\n}"
response = http.request(request)
puts response.read_body{
"status": "failed",
"message": "Authentication credentials were not provided."
}Customer Onboarding
Update Onboarding Settings
Enable or disable identity verification and AML screening for your branch.
POST
/
api
/
onboarding
/
settings
Update Onboarding Settings
curl --request POST \
--url https://adhere-api.smartcomply.com/api/onboarding/settings \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"ivs": true,
"aml": true
}
'import requests
url = "https://adhere-api.smartcomply.com/api/onboarding/settings"
payload = {
"ivs": True,
"aml": True
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({ivs: true, aml: true})
};
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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'ivs' => true,
'aml' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://adhere-api.smartcomply.com/api/onboarding/settings"
payload := strings.NewReader("{\n \"ivs\": true,\n \"aml\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://adhere-api.smartcomply.com/api/onboarding/settings")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"ivs\": true,\n \"aml\": true\n}")
.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::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ivs\": true,\n \"aml\": true\n}"
response = http.request(request)
puts response.read_body{
"status": "failed",
"message": "Authentication credentials were not provided."
}Use this endpoint to control which steps run during the Verify Customer call. Changes apply to all subsequent onboarding requests for your branch.
You can update one or both settings in a single call. Omitted fields retain their current value.
Both
ivs and aml are enabled by default. Disabling ivs will also cause AML screening to be skipped, since screening depends on a verified name being returned from the identity check.Endpoint
POST /api/onboarding/settings
Request
Headers
| Header | Value | Required |
|---|---|---|
x-access-token | Your API key | Yes |
Content-Type | application/json | Yes |
Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
ivs | boolean | No | Enable or disable identity verification |
aml | boolean | No | Enable or disable AML screening |
Example
curl -X POST https://adhere-api.smartcomply.com/api/onboarding/settings \
-H "x-access-token: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "aml": false }'
import requests
response = requests.post(
"https://adhere-api.smartcomply.com/api/onboarding/settings",
headers={"x-access-token": "YOUR_API_KEY"},
json={"aml": False},
)
print(response.json())
const response = await fetch("https://adhere-api.smartcomply.com/api/onboarding/settings", {
method: "POST",
headers: {
"x-access-token": "YOUR_API_KEY",
"Content-Type": "application/json",
},
body: JSON.stringify({ aml: false }),
});
const data = await response.json();
Response
"success" on a successful update."Settings saved"200 OK
{
"status": "success",
"message": "Settings saved",
"data": {
"ivs": true,
"aml": false
}
}
Error Responses
| HTTP Status | Message | Cause |
|---|---|---|
401 | "Authorization token is missing" | No x-access-token header |
401 | "Authorization failed" | Token not recognised or expired |
400 | "Invalid value for ivs" | Value must be a boolean |
400 | "Invalid value for aml" | Value must be a boolean |
⌘I

