# Verify Phone Number

## Phone-Number Verification

<mark style="color:green;">`POST`</mark> `{{baseurl}}/v2/api/identity/ng/phone`

#### Headers

| Name                                    | Type   | Description      |
| --------------------------------------- | ------ | ---------------- |
| token<mark style="color:red;">\*</mark> | String | API secret token |

#### Request Body

| Name                                               | Type    | Description                                                                        |
| -------------------------------------------------- | ------- | ---------------------------------------------------------------------------------- |
| mobile<mark style="color:red;">\*</mark>           | String  | Valid phone number                                                                 |
| isSubjectConsent<mark style="color:red;">\*</mark> | Boolean | Indicate subject has given consent. <mark style="color:red;">`Must be true`</mark> |
| metadata                                           | Object  | Metadata object. Any valid object can be passed here. It gets returned as is.      |

### <mark style="color:green;">Phone Number Verification</mark>

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

{% tabs %}
{% tab title="Basic Phone number Verification Sample Request" %}

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

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Found Response:" %}

```json
{
        "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": []
    }
```

{% endtab %}

{% tab title="Not Found Response:" %}

```json
{
            "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": []
        
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Error Responses:" %}

```json
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": {}
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.youverify.co/know-your-customer-services-kyc/id-data-matching-eidv/nigeria/verify-phone-number.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.