Skip to main content
POST
/
api
/
onboarding
/
nigeria_kyc
/
phone_no_basic
Phone Number Basic
curl --request POST \
  --url https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/phone_no_basic/ \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "phone_number": "08012345678"
}
'
{
  "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 Phone Number Basic endpoint returns the name and date of birth associated with the primary phone number registered against a customer’s NIN. For other numbers linked to the same NIN, use Phone Number Advanced.

Endpoint

POST /api/onboarding/nigeria_kyc/phone_no_basic/

Request

Headers

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

Body Parameters

ParameterTypeRequiredDescription
phone_numberstringYesThe customer’s phone number (Nigerian format, e.g., 09011001100)

Example

curl -X POST "https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/phone_no_basic/" \
  -H "x-access-token: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"phone_number": "09011001100"}'

Response

200 OK

FieldTypeDescription
data.surnamestringLast name
data.firstNamestringFirst name
data.middleNamestringMiddle name
data.dateOfBirthstringDate of birth in YYYY-MM-DD format
data.phoneNumberstringPhone number that was queried
{
  "status": "success",
  "data": {
    "surname": "AKINSANYA",
    "firstName": "TISEOLUWA",
    "middleName": "JOHN",
    "dateOfBirth": "1909-09-19",
    "phoneNumber": "09011001100"
  },
  "message": "Phone Number details retrieved successfully"
}

400 Bad Request

{
  "status": "failed",
  "data": [],
  "message": "Sorry, your check cannot be processed at the moment. Please try again in a few minutes"
}

401 Unauthorized

{
  "status": "failed",
  "message": "Authentication credentials were not provided."
}

Authorizations

x-access-token
string
header
required

Your Adhere API secret key

Body

application/json
phone_number
string
required
Example:

"08012345678"

Response

Phone basic data retrieved