Request a Guarantor Address Verification

curl --request POST \
  --url https://api.youverify.co/v2/api/addresses/guarantor/request \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "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"
  }
}
'

import requests

url = "https://api.youverify.co/v2/api/addresses/guarantor/request"

payload = {
    "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" }
}
headers = {
    "token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'}
  })
};

fetch('https://api.youverify.co/v2/api/addresses/guarantor/request', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.youverify.co/v2/api/addresses/guarantor/request",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.youverify.co/v2/api/addresses/guarantor/request"

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

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.youverify.co/v2/api/addresses/guarantor/request")
  .header("token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"candidateId\": \"6184e3c081ee218921cb9e85\",\n  \"description\": \"Verify the candidate and guarantor\",\n  \"guarantor\": {\n    \"firstName\": \"James\",\n    \"lastName\": \"Olinya\",\n    \"mobile\": \"08036xxxxxx\",\n    \"email\": \"test3@gmail.com\",\n    \"image\": \"https://cdn.youverify.co/1655466566309-lLSfNTlhElMTtbXW-QE-q.jpg\"\n  },\n  \"address\": {\n    \"flatNumber\": \"1st floor\",\n    \"buildingName\": \"Sum house\",\n    \"buildingNumber\": \"350\",\n    \"landmark\": \"Police Station\",\n    \"street\": \"Borno way\",\n    \"subStreet\": \"Hughes avenue\",\n    \"state\": \"Lagos\",\n    \"city\": \"Yaba\",\n    \"lga\": \"Lagos Mainland\"\n  },\n  \"subjectConsent\": true,\n  \"metadata\": {\n    \"requestId\": \"1209348756\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.youverify.co/v2/api/addresses/guarantor/request")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"candidateId\": \"6184e3c081ee218921cb9e85\",\n  \"description\": \"Verify the candidate and guarantor\",\n  \"guarantor\": {\n    \"firstName\": \"James\",\n    \"lastName\": \"Olinya\",\n    \"mobile\": \"08036xxxxxx\",\n    \"email\": \"test3@gmail.com\",\n    \"image\": \"https://cdn.youverify.co/1655466566309-lLSfNTlhElMTtbXW-QE-q.jpg\"\n  },\n  \"address\": {\n    \"flatNumber\": \"1st floor\",\n    \"buildingName\": \"Sum house\",\n    \"buildingNumber\": \"350\",\n    \"landmark\": \"Police Station\",\n    \"street\": \"Borno way\",\n    \"subStreet\": \"Hughes avenue\",\n    \"state\": \"Lagos\",\n    \"city\": \"Yaba\",\n    \"lga\": \"Lagos Mainland\"\n  },\n  \"subjectConsent\": true,\n  \"metadata\": {\n    \"requestId\": \"1209348756\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "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",
    "id": "618873cba993f7924d114409"
  },
  "links": []
}

{
  "success": false,
  "statusCode": 401,
  "message": "Permission denied",
  "name": "UnauthorizedError",
  "data": {}
}

{
  "success": false,
  "statusCode": 402,
  "message": "Insufficient fund",
  "name": "PaymentRequiredError",
  "data": {}
}

{
  "success": false,
  "statusCode": 403,
  "message": "Permission denied",
  "name": "UnauthorizedError",
  "data": {}
}

{
  "success": false,
  "statusCode": 429,
  "message": "Too many requests",
  "name": "RateLimitError",
  "data": {}
}

{
  "success": false,
  "statusCode": 500,
  "message": "Service unavailable",
  "name": "Error",
  "data": {}
}