> For the complete documentation index, see [llms.txt](https://doc.youverify.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.youverify.co/know-your-customer-services-kyc/address-verification-service-for-individuals/physical-address-verification-service/request-a-guarantor-address-verification.md).

# Request a Guarantor Address Verification

**Note**: Before you create an address verification you must have created a candidate (the information of the person to be verified). If you missed how to create a candidate click [here](/know-your-customer-services-kyc/address-verification-service-for-individuals/physical-address-verification-service/create-a-candidate.md).

## Guarantor Address Request

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

#### Headers

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

#### Request Body

| Name                                             | Type   | Description                                                                   |
| ------------------------------------------------ | ------ | ----------------------------------------------------------------------------- |
| candidateId<mark style="color:red;">\*</mark>    | String | candidate ID                                                                  |
| subjectConsent<mark style="color:red;">\*</mark> | Object | Candidate consent must be <mark style="color:red;">`true`</mark>              |
| description                                      | String | Description or any information for the agent                                  |
| address<mark style="color:red;">\*</mark>        | Object | Guarantor address object                                                      |
| flatNumber                                       | String | Address flat number                                                           |
| buildingName                                     | String | Address building name                                                         |
| buildingNumber<mark style="color:red;">\*</mark> | String | Address building number                                                       |
| landmark<mark style="color:red;">\*</mark>       | String | Address landmark                                                              |
| street<mark style="color:red;">\*</mark>         | String | Address street                                                                |
| subStreet                                        | String | Address sub stree                                                             |
| state<mark style="color:red;">\*</mark>          | String | Address state                                                                 |
| city<mark style="color:red;">\*</mark>           | String | Address city                                                                  |
| lga                                              | String | Address local government                                                      |
| guarantor<mark style="color:red;">\*</mark>      | Object | Guarantor object                                                              |
| firstName<mark style="color:red;">\*</mark>      | String | Guarantor first name                                                          |
| lastName<mark style="color:red;">\*</mark>       | String | Guarantor last name                                                           |
| mobile<mark style="color:red;">\*</mark>         | String | Guarantor mobile                                                              |
| email<mark style="color:red;">\*</mark>          | String | Guarantor email address                                                       |
| image<mark style="color:red;">\*</mark>          | String | Guarantor image                                                               |
| metadata                                         | Object | Metadata object. Any valid object can be passed here. It gets returned as is. |

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

```json
{
    "candidateId": "6184e3c081ee218921cb9e85",
    "description": "Verify the candidate and guarantor",
    "guarantor": {
        "firstName": "James",
        "lastName": "Olinya",
        "mobile": "08036xxxxxx",
        "email": "test3@gmail.com",
        "image": "https://cdn.youverify.co/1655466566309-lLSfNTlhElMTtbXW-QE-q.jpg"
    },
    "address": {
        "flatNumber": "1st floor",
        "buildingName": "Sum house",
        "buildingNumber": "350",
        "landmark": "Police Station",
        "street": "Borno way",
        "subStreet": "Hughes avenue",
        "state": "Lagos",
        "city": "Yaba",
        "lga": "Lagos Mainland"
    },
     "subjectConsent": true,
     "metadata": {
        "requestId": "1209348756"
},
}
```

{% endtab %}
{% endtabs %}

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

```json
HTTP/1.1 201 CREATED
{
          "success": true,
          "statusCode": 201,
          "message": "Address requested successfully!",
          "data": {
              "candidate": {
                  "candidateId": "6184e3c081ee238921cb9e86",
                  "firstName": "FAMOUS",
                  "middleName": "PRIOR",
                  "lastName": "EHICHIOYA",
                  "photo": "https://cdn.youverify.co/1655466566309-lLSfNTlhElMTtbXW-QE-q.jpg",
                  "email": null,
                  "mobile": "08036xxxxxx"
              },
              "guarantor": {
                  "firstName": "James",
                  "middleName": null,
                  "lastName": "Olinya",
                  "photo": "https://cdn.youverify.co/1655466566309-lLSfNTlhElMTtbXW-QE-q.jpg",
                  "email": "test3@gmail.com",
                  "mobile": "08036xxxxxx"
              },
              "agent": {
                  "firstName": null,
                  "middleName": null,
                  "lastName": null,
                  "signature": null,
                  "photo": null
              },
              "address": {
                  "latlong": {
                      "lat": "6.500871399999999",
                      "lon": "3.3765867"
                  },
                  "flatNumber": "1st floor",
                  "buildingName": "Sum house",
                  "buildingNumber": "350",
                  "subStreet": "Hughes avenue",
                  "street": "Borno way",
                  "landmark": "Police Station",
                  "state": "Lagos",
                  "city": "Yaba",
                  "country": "Nigeria",
                  "lga": "Lagos Mainland"
              },
              "referenceId": "618873bc9030d",
              "status": "pending",
              "taskStatus": "PENDING",
              "subjectConsent": "true",
              "startDate": null,
              "endDate": null,
              "submittedAt": null,
              "executionDate": null,
              "completedAt": null,
              "acceptedAt": null,
              "revalidationDate": null,
              "notes": [],
              "isFlagged": false,
              "agentSubmittedLongitude": null,
              "agentSubmittedLatitude": null,
              "reportGeolocationUrl": null,
              "mapAddressUrl": null,
              "submissionDistanceInMeters": null,
              "reasons": null,
              "signature": null,
              "images": [],
              "buildingType": null,
              "buildingColor": null,
              "gatePresent": null,
              "gateColor": null,
              "availabilityConfirmedBy": null,
              "closestLandmark": null,
              "additionalInfo": null,
              "reportAgentAccess": null,
              "incidentReport": null,
              "description": "Verify the candidate and guarantor",
              "reportId": "reports_905a5c02-ba37-411f-b494-f904f0a6d994",
              "downloadUrl": null,
              "businessType": "admin",
              "businessId": "615c2deb203b96532838418b",
              "userId": "615c2deb203b96532838418c",
              "type": "guarantor",
              "createdAt": "2021-11-08T00:48:11.998Z",
              "lastModifiedAt": "2021-11-08T00:48:11.998Z",
              "_createdAt": "2021-11-08T01:48:1111+01:00",
              "_lastModifiedAt": "2021-11-08T01:48:1111+01:00",
              "id": "618873cba993f7924d114409"
          },
          "links": []
      }
```

{% endtab %}
{% endtabs %}

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

```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 %}

{% tab title="Second Tab" %}

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://doc.youverify.co/know-your-customer-services-kyc/address-verification-service-for-individuals/physical-address-verification-service/request-a-guarantor-address-verification.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.