Skip to main content
POST
/
onboarding
/
verify_customer
Verify Customer
curl --request POST \
  --url https://adhere-api.smartcomply.com/onboarding/verify_customer \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "country": "nigeria",
  "identifier": "12345678901",
  "identifier_type": "bvn"
}
'
{
  "status": "failed",
  "data": [
    "<unknown>"
  ],
  "message": "<string>"
}

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

POST /onboarding/verify_customer

​
Request

​
Headers

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

​
Body Parameters

ParameterTypeRequiredDescription
countrystringYesCountry of the customer. Supported: nigeria, kenya, ghana, uganda, rwanda
identifierstringYesThe customer’s ID number (e.g. BVN, NIN, National ID)
identifier_typestringNoOverrides the country default. See supported values

​
Example

curl -X POST https://adhere-api.smartcomply.com/onboarding/verify_customer \
  -H "x-access-token: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "country": "nigeria",
    "identifier": "12345678901"
  }'

​
Response

All responses return HTTP 200. Use the decision field — not the HTTP status — to determine the onboarding outcome. See the Decision Guide for how to act on each value.
​
status
string
Always "success" on a 200 response.
​
message
string
Always "Customer onboarding completed" on success.
​
data
object

​
Pass — identity verified, no matches

{
  "status": "success",
  "message": "Customer onboarding completed",
  "data": {
    "onboarding_id": 1024,
    "identity": {
      "verified": true,
      "identifier_type": "BVN",
      "first_name": "Amaka",
      "middle_name": "Chisom",
      "last_name": "Okafor",
      "date_of_birth": "1992-04-17",
      "gender": "Female",
      "phone": "08031234567"
    },
    "screening": {
      "sanctions": [],
      "peps": [],
      "adverse_media": [],
      "risk_level": "low"
    },
    "decision": "pass"
  }
}

​
Review — identity verified, PEP match found

{
  "status": "success",
  "message": "Customer onboarding completed",
  "data": {
    "onboarding_id": 1025,
    "identity": {
      "verified": true,
      "identifier_type": "NIN",
      "first_name": "Emeka",
      "last_name": "Nwosu",
      "date_of_birth": "1985-11-02",
      "gender": "Male"
    },
    "screening": {
      "sanctions": [],
      "peps": [
        {
          "name": "Emeka Nwosu",
          "pep_types": ["role.pep", "pep-class-2"],
          "gender": "male",
          "source": "OpenSanctions",
          "country": "Nigeria",
          "political_post": ["Former State Commissioner"]
        }
      ],
      "adverse_media": [],
      "risk_level": "medium"
    },
    "decision": "review"
  }
}

​
Fail — identity verification unsuccessful

{
  "status": "success",
  "message": "Customer onboarding completed",
  "data": {
    "onboarding_id": 1026,
    "identity": {
      "verified": false,
      "identifier_type": "BVN",
      "error": "Bank Verification Number (BVN) check failed: Invalid BVN provided"
    },
    "screening": {
      "sanctions": [],
      "peps": [],
      "adverse_media": [],
      "risk_level": "low",
      "note": "AML screening skipped: identity verification did not return a name"
    },
    "decision": "fail"
  }
}

​
Error Responses

HTTP StatusMessageCause
401"Authorization token is missing"No x-access-token header
401"Authorization failed"Token not recognised or expired
403"Identity Verification suite isn't enabled for this branch"Feature not activated — contact support
403"Your account hasn't been verified for Identity Verification Suite"Admin account pending verification
400"country is required"Missing country field
400"identifier is required"Missing identifier field
400"Unsupported country '…'. Supported: …"Invalid country value
400"Unsupported identifier_type '…' for …. Supported: …"Invalid identifier_type for the given country

Authorizations

​
x-access-token
string
header
required

Your Adhere API secret key

Body

application/json
​
country
enum<string>
required

Country of the customer

Available options:
nigeria,
kenya,
ghana,
uganda,
rwanda
Example:

"nigeria"

​
identifier
string
required

The ID number to verify (BVN, NIN, National ID, etc.)

Example:

"12345678901"

​
identifier_type
string

Overrides the country default. Nigeria: bvn, nin, vnin. Others: national_id or ghana_id.

Example:

"bvn"

Response

Onboarding completed — check decision field for pass/review/fail