Verify Phone Number

Phone-Number Verification

POST {{baseurl}}/v2/api/identity/ng/phone

Headers

Name	Type	Description
token*	String	API secret token

Request Body

Name	Type	Description
mobile*	String	Valid phone number
isSubjectConsent*	Boolean	Indicate subject has given consent. Must be true
metadata	Object	Metadata object. Any valid object can be passed here. It gets returned as is.

Phone Number Verification

The Basic Phone Number Verification is used to verify the owner of a phone number

Basic Phone number Verification Sample Request

{
    "mobile": "08000000000",
    "isSubjectConsent": true
}

Found Response:

{
        "success": true,
        "statusCode": 200,
        "message": "success",
        "data": {
            "parentId": "612ce40ab8919f39faf7ae49",
            "status": "found",
            "dataValidation": false,
            "selfieValidation": false,
            "phoneDetails": [
                {
                    "fullName": "EHICHIOYA FAMOUS PRIOR",
                    "dateOfBirth": "2000-01-01"
                },
                {
                    "fullName": "EHICHIOYA FAMOUS PRIOR",
                    "dateOfBirth": "2000-01-03"
                }
            ],
            "isConsent": true,
            "idNumber": "08036xxxxxx",
            "businessId": "619b683ecb55a2a588f4b83c",
            "type": "phone",
            "requestedAt": "2021-12-15T00:20:53.143Z",
            "country": "NG",
            "createdAt": "2021-12-15T00:20:53.334Z",
            "lastModifiedAt": "2021-12-15T00:20:53.334Z",
            "id": "61b934dfaab326675cdfaab326",
            "requestedBy": {
                "firstName": "API",
                "lastName": "User",
                "middleName": "",
                "id": "619b683ecb55a2a588f4b839"
            }
        },
        "links": []
    }

Not Found Response:

{
            "success": true,
            "statusCode": 200,
            "message": "success",
            "data": {
                "id": "62620a9737fc51c378f4a68a",
                "address": {
                    "town": null,
                    "lga": null,
                    "state": null,
                    "addressLine": null
                },
                "parentId": null,
                "status": "not_found",
                "dataValidation": false,
                "selfieValidation": false,
                "firstName": null,
                "middleName": null,
                "lastName": null,
                "image": null,
                "email": null,
                "nin": null,
                "birthState": null,
                "religion": null,
                "birthLGA": null,
                "birthCountry": null,
                "dateOfBirth": null,
                "isConsent": true,
                "idNumber": "07036208559",
                "businessId": "61d880f1e8e15aaf24558f1a",
                "type": "phone",
                "gender": "",
                "requestedAt": "2022-04-22T01:53:28.686Z",
                "country": "NG",
                "createdAt": "2022-04-22T01:53:28.843Z",
                "lastModifiedAt": "2022-04-22T01:53:28.843Z",
                "advanceSearch": true,
                "requestedBy": {
                    "firstName": "Famous",
                    "lastName": "Ehichioya",
                    "middleName": "Prior",
                    "id": "61d880f2e8e15aaf24558f9b"
                }
            },
            "links": []
        

Error Responses:

HTTP/1.1 402 Payment Required
  {
    "success": false,
    "statusCode": 402,
    "message": "Insufficient fund",
    "name": "PaymentRequiredError",
    "data": {}
}


HTTP/1.1 500 Internal Server Error
{
    "success": false,
    "statusCode": 500,
    "message": "Service unavailable",
    "name": "Error",
    "data": {}
}

HTTP/1.1 403 Forbidden
{
    "success": false,
    "statusCode": 403,
    "message": "Permission denied",
    "name": "UnauthorizedError",
    "data": {}
}