Skip to main content
POST
/
onboarding
/
settings
Update Onboarding Settings
curl --request POST \
  --url https://adhere-api.smartcomply.com/onboarding/settings \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "ivs": true,
  "aml": true
}
'
{
  "status": "failed",
  "message": "Authentication credentials were not provided."
}

Documentation Index

Fetch the complete documentation index at: https://docs.smartcomply.com/llms.txt

Use this file to discover all available pages before exploring further.

Use this endpoint to control which steps run during the Verify Customer call. Changes apply to all subsequent onboarding requests for your branch.
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 /onboarding/settings

​
Request

​
Headers

HeaderValueRequired
x-access-tokenYour API keyYes
Content-Typeapplication/jsonYes

​
Body Parameters

ParameterTypeRequiredDescription
ivsbooleanNoEnable or disable identity verification
amlbooleanNoEnable or disable AML screening
You can update one or both settings in a single call. Omitted fields retain their current value.

​
Example

curl -X POST https://adhere-api.smartcomply.com/onboarding/settings \
  -H "x-access-token: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "aml": false }'

​
Response

​
status
string
"success" on a successful update.
​
message
string
"Settings saved"
​
data
object
The full settings state after the update.

​
200 OK

{
  "status": "success",
  "message": "Settings saved",
  "data": {
    "ivs": true,
    "aml": false
  }
}

​
Error Responses

HTTP StatusMessageCause
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

Authorizations

​
x-access-token
string
header
required

Your Adhere API secret key

Body

application/json
​
ivs
boolean

Enable or disable identity verification

​
aml
boolean

Enable or disable AML screening

Response

Settings saved