Phone Number Basic

Retrieve core identity data for the primary phone number registered to a customer’s NIN.

POST /api/onboarding/nigeria_kyc/phone_no_basic/

Phone Number Basic

cURL

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"
}
'

400

{
  "status": "failed",
  "data": [
    "<unknown>"
  ],
  "message": "<string>"
}

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

Header	Value	Required
x-access-token	Your API secret key	Yes
Content-Type	application/json	Yes

Body Parameters

Parameter	Type	Required	Description
phone_number	string	Yes	The customer’s phone number (Nigerian format, e.g., 09011001100)

Example

cURL

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

Field	Type	Description
data.surname	string	Last name
data.firstName	string	First name
data.middleName	string	Middle name
data.dateOfBirth	string	Date of birth in YYYY-MM-DD format
data.phoneNumber	string	Phone 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

200

Phone basic data retrieved