Phone Number Verification

Phone Number Lookup API

To perform verification on a phone number, make a POST request to the following endpoint;

https://api.korapay.com/merchant/api/v1/identities/ng/phone

The request body should have the following parameters:

{ "id": "08000000000", "verification_consent": true }

The fields in this request include:

FieldData TypeDescription
idStringRequired - the ID number
verification_consentBooleanRequired - this indicates that subject has given consent to perform this verification. This must be true for the check to be performed.

The response to this request would look like this:

{ "status": true, "message": "Phone number verified successfully", "data": { "reference": "VR-HtMZpQfPmYc4Xby5N", "id": "08000000000", "id_type": "ng_phone", "first_name": "JOHN", "last_name": "DOE", "middle_name": "MICHAEL", "full_name": "JOHN MICHAEL DOE", "date_of_birth": "1977-04-04", "requested_by": "API User" } }

A webhook notification will also be sent to your application immediately the phone number verification is completed.


Did this page help you?
Français
Powered by Localize
English