# Create a candidate via Identity

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

#### Headers

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

#### Request Body

| Name                                             | Type    | Description                                                        |
| ------------------------------------------------ | ------- | ------------------------------------------------------------------ |
| type<mark style="color:red;">\*</mark>           | String  | type of ID. One of <mark style="color:red;">`bvn, nin, ndl`</mark> |
| idNumber<mark style="color:red;">\*</mark>       | String  | ID base on the provided type                                       |
| subjectConsent<mark style="color:red;">\*</mark> | Boolean | Candidate consent. Must be <mark style="color:red;">`true`</mark>  |

{% tabs %}
{% tab title="Sample Request" %}

```json
{
    "type": "bvn",
    "idNumber": "00000000000",
    "subjectConsent": true
}
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Success Response" %}

```json
HTTP/1.1 201 CREATED
{
        "success": true,
        "statusCode": 201,
        "message": "Candidate created successfully!",
        "data": {
            "firstName": "Peter",
            "middleName": "Phillip",
            "lastName": "Uche",
            "dateOfBirth": "1950-02-04",
            "photo": "data:image/jpg;base64,/9j/4AAQSkZJRgABAgAAAQAB"
            "email": null,
            "mobile": "08000000000",
            "idNumber": "00000000000",
            "type": "bvn",
            "medium": "identity",
            "createdAt": "2021-11-05T07:56:48.953Z",
            "lastModifiedAt": "2021-11-05T07:56:48.953Z",
            "_createdAt": "2021-11-05T08:56:4848+01:00",
            "_lastModifiedAt": "2021-11-05T08:56:4848+01:00",
            "id": "6184e3c081ee238921cb9e86"
        },
        "links": []
    }
```

{% endtab %}
{% endtabs %}

<br>


---

# 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-business-services-kyb/country-specific-kyb-services/nigeria/address-verification-services-for-businesses/create-a-candidate/create-a-candidate-via-identity.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.