Retrieve an Address Verification

curl --request GET \
  --url https://api.youverify.co/v2/api/addresses/{addressId} \
  --header 'token: <api-key>'

import requests

url = "https://api.youverify.co/v2/api/addresses/{addressId}"

headers = {"token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {token: '<api-key>'}};

fetch('https://api.youverify.co/v2/api/addresses/{addressId}', 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/{addressId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.youverify.co/v2/api/addresses/{addressId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("token", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.youverify.co/v2/api/addresses/{addressId}")
  .header("token", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.youverify.co/v2/api/addresses/{addressId}")

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

request = Net::HTTP::Get.new(url)
request["token"] = '<api-key>'

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

{
  "success": true,
  "statusCode": 200,
  "message": "Address retrieved successfully!",
  "data": {
    "candidate": {
      "candidateId": "62973912fdc2225c65bb1302",
      "firstName": "John",
      "middleName": "Michael",
      "lastName": "Doe",
      "photo": "https://youverify-api-bucket.nyc3.digitaloceanspaces.com/reports/live_photos/2022-06-01/photo_6297396bc723f8246.png",
      "email": "famous@youverify.co",
      "mobile": "08030000000"
    },
    "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": "6297396cc0dea",
    "parentId": null,
    "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",
    "reportId": "reports_f1b762e8-c65b-4efa-9e6c-4aad8f258013",
    "downloadUrl": null,
    "apiVersion": "v2",
    "businessType": "admin",
    "businessId": "61d880f1e8e15aaf24558f1a",
    "userId": "61d880f2e8e15aaf24558f9b",
    "type": "individual",
    "metadata": {},
    "createdAt": "2022-06-01T10:03:37.110Z",
    "lastModifiedAt": "2022-06-01T10:03:37.110Z",
    "verificationId": "6297396cc0dea",
    "id": "62973964fdc2225c65bb1303",
    "user": {
      "firstName": "Famous",
      "lastName": "Ehichioya",
      "middleName": "Prior",
      "email": "developer@youverify.co",
      "mobile": "+2348036208556",
      "countryCode": "NG",
      "id": "61d880f2e8e15aaf24558f9b"
    }
  },
  "links": []
}

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

{
  "success": false,
  "statusCode": 404,
  "message": "Not found",
  "name": "ResourceNotFoundError",
  "data": {}
}

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

{
  "success": false,
  "statusCode": 500,
  "message": "Internal Server Error",
  "name": "Error",
  "data": {}
}