Skip to main content
GET
/
onboarding
/
settings
Get Onboarding Settings
curl --request GET \
  --url https://adhere-api.smartcomply.com/onboarding/settings \
  --header 'x-access-token: <api-key>'
{
  "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.

​
Endpoint

GET /onboarding/settings

​
Request

​
Headers

HeaderValueRequired
x-access-tokenYour API keyYes

​
Example

curl https://adhere-api.smartcomply.com/onboarding/settings \
  -H "x-access-token: YOUR_API_KEY"

​
Response

​
status
string
"success" on a successful request.
​
message
string
"Settings retrieved"
​
data
object

​
200 OK

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

​
Error Responses

HTTP StatusMessageCause
401"Authorization token is missing"No x-access-token header
401"Authorization failed"Token not recognised or expired

Authorizations

​
x-access-token
string
header
required

Your Adhere API secret key

Response

Settings retrieved