KYC - Address Verification (Individuals)
Search for a Candidate
Retrieves a previously created address-verification candidate by candidate ID.
GET
/
v2
/
api
/
addresses
/
candidates
/
{candidateId}
Search for a Candidate
curl --request GET \
--url https://api.youverify.co/v2/api/addresses/candidates/{candidateId} \
--header 'token: <api-key>'import requests
url = "https://api.youverify.co/v2/api/addresses/candidates/{candidateId}"
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/candidates/{candidateId}', 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/candidates/{candidateId}",
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/candidates/{candidateId}"
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/candidates/{candidateId}")
.header("token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.youverify.co/v2/api/addresses/candidates/{candidateId}")
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": 201,
"message": "Candidate retrieved successfully!",
"data": {
"firstName": "FAMOUS",
"middleName": "PRIOR",
"lastName": "EHICHIOYA",
"dateOfBirth": "2000-01-01",
"photo": "data:image/jpg;base64,...",
"email": null,
"mobile": "08036xxxxxx",
"idNumber": "22328xxxxxx",
"businessId": "615c2deb203b96532838418b",
"type": "bvn",
"medium": "identity",
"createdAt": "2021-11-12T09:29:01.516Z",
"lastModifiedAt": "2021-11-12T09:29:01.516Z",
"id": "618e33dd0b96f3c4397332f1"
},
"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": 404,
"message": "Not found",
"name": "ResourceNotFoundError",
"data": {}
}{
"success": false,
"statusCode": 429,
"message": "Too many requests",
"name": "RateLimitError",
"data": {}
}{
"success": false,
"statusCode": 500,
"message": "Service unavailable",
"name": "Error",
"data": {}
}⌘I
Search for a Candidate
curl --request GET \
--url https://api.youverify.co/v2/api/addresses/candidates/{candidateId} \
--header 'token: <api-key>'import requests
url = "https://api.youverify.co/v2/api/addresses/candidates/{candidateId}"
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/candidates/{candidateId}', 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/candidates/{candidateId}",
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/candidates/{candidateId}"
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/candidates/{candidateId}")
.header("token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.youverify.co/v2/api/addresses/candidates/{candidateId}")
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": 201,
"message": "Candidate retrieved successfully!",
"data": {
"firstName": "FAMOUS",
"middleName": "PRIOR",
"lastName": "EHICHIOYA",
"dateOfBirth": "2000-01-01",
"photo": "data:image/jpg;base64,...",
"email": null,
"mobile": "08036xxxxxx",
"idNumber": "22328xxxxxx",
"businessId": "615c2deb203b96532838418b",
"type": "bvn",
"medium": "identity",
"createdAt": "2021-11-12T09:29:01.516Z",
"lastModifiedAt": "2021-11-12T09:29:01.516Z",
"id": "618e33dd0b96f3c4397332f1"
},
"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": 404,
"message": "Not found",
"name": "ResourceNotFoundError",
"data": {}
}{
"success": false,
"statusCode": 429,
"message": "Too many requests",
"name": "RateLimitError",
"data": {}
}{
"success": false,
"statusCode": 500,
"message": "Service unavailable",
"name": "Error",
"data": {}
}