Skip to main content
POST
/
api
/
onboarding
/
nigeria_kyc
/
digital_address_verification
Digital Address Verification
curl --request POST \
  --url https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/digital_address_verification/ \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "first_name": "<string>",
  "last_name": "<string>",
  "phone_number": "<string>",
  "address": "<string>",
  "lga": "<string>",
  "state": "<string>"
}
'
{
  "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.

The Digital Address Verification endpoint initiates a digital address check using cross-referenced data sources. Returns a reference ID to track completion via the Digital Address Confirmation endpoint.

Endpoint

POST /api/onboarding/nigeria_kyc/digital_address_verification/

Request

Headers

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

Body Parameters

ParameterTypeRequiredDescription
first_namestringYesCustomer’s first name
last_namestringYesCustomer’s last name
ninstringYesCustomer’s 11-digit NIN
phone_numberstringYesCustomer’s phone number
birth_datestringYesDate of birth (format: DD/MM/YYYY)
streetstringYesFull street address
citystringYesCity
lgastringYesLocal government area
statestringYesState
landmarkstringNoNearby landmark to aid verification

Example

curl -X POST "https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/digital_address_verification/" \
  -H "x-access-token: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "John", "last_name": "Doe",
    "nin": "10000000001", "phone_number": "08000000000",
    "birth_date": "17/01/1988",
    "street": "270 Murtala Muhammed Way, Alagomeji. Yaba",
    "city": "oshodi", "lga": "lagos mainland",
    "state": "Lagos", "landmark": "lagos"
  }'

Response

200 OK

FieldTypeDescription
data.idintegerVerification record ID
data.referencestringReference ID — pass this to the confirmation endpoint
data.status.verificationstringInitial verification status
{
  "status": "success",
  "data": {
    "id": 1,
    "applicant": {
      "firstname": "John",
      "lastname": "Doe",
      "phone": "08000000000",
      "idType": "nin",
      "idNumber": "10000000001",
      "gender": "Male",
      "birthdate": "17/01/1988"
    },
    "createdAt": "",
    "completedAt": "",
    "status": {
      "verification": "In progress"
    },
    "city": "oshodi",
    "street": "270 Murtala Muhammed Way, Alagomeji. Yaba",
    "lga": "lagos mainland",
    "state": "Lagos",
    "country": "Nigeria",
    "reference": "1732800207805106"
  }
}

400 Bad Request

{
  "status": "failed",
  "data": [],
  "message": "Missing required fields"
}

Authorizations

x-access-token
string
header
required

Your Adhere API secret key

Body

application/json
first_name
string
required
last_name
string
required
phone_number
string
required
address
string
required
lga
string
required
state
string
required

Response

Digital address verification submitted