KYC - Address Verification (Individuals)
Create a Candidate via Identity
Creates an address-verification candidate using a previously verified BVN, NIN, or driver’s license identity.
POST
/
v2
/
api
/
addresses
/
candidates
/
identity
Create a Candidate via Identity
curl --request POST \
--url https://api.youverify.co/v2/api/addresses/candidates/identity \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"type": "bvn",
"idNumber": "00000000000",
"subjectConsent": true
}
'import requests
url = "https://api.youverify.co/v2/api/addresses/candidates/identity"
payload = {
"type": "bvn",
"idNumber": "00000000000",
"subjectConsent": True
}
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({type: 'bvn', idNumber: '00000000000', subjectConsent: true})
};
fetch('https://api.youverify.co/v2/api/addresses/candidates/identity', 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/identity",
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([
'type' => 'bvn',
'idNumber' => '00000000000',
'subjectConsent' => true
]),
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/candidates/identity"
payload := strings.NewReader("{\n \"type\": \"bvn\",\n \"idNumber\": \"00000000000\",\n \"subjectConsent\": true\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/candidates/identity")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"bvn\",\n \"idNumber\": \"00000000000\",\n \"subjectConsent\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.youverify.co/v2/api/addresses/candidates/identity")
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 \"type\": \"bvn\",\n \"idNumber\": \"00000000000\",\n \"subjectConsent\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 201,
"message": "Candidate created successfully!",
"data": {
"firstName": "Peter",
"middleName": "Phillip",
"lastName": "Uche",
"dateOfBirth": "1950-02-04",
"photo": "data:image/jpg;base64,...",
"email": null,
"mobile": "08000000000",
"idNumber": "00000000000",
"type": "bvn",
"medium": "identity",
"createdAt": "2021-11-05T07:56:48.953Z",
"lastModifiedAt": "2021-11-05T07:56:48.953Z",
"id": "6184e3c081ee238921cb9e86"
},
"links": []
}{
"success": false,
"statusCode": 401,
"message": "Permission denied",
"name": "UnauthorizedError",
"data": {}
}{
"success": false,
"statusCode": 402,
"message": "Insufficient fund",
"name": "PaymentRequiredError",
"data": {}
}{
"success": false,
"statusCode": 429,
"message": "Too many requests",
"name": "RateLimitError",
"data": {}
}{
"success": false,
"statusCode": 500,
"message": "Internal Server Error",
"name": "Error",
"data": {}
}Authorizations
Your Youverify API secret key. Never expose client-side.
Headers
API secret token
Body
application/json
Response
Candidate created
⌘I
Create a Candidate via Identity
curl --request POST \
--url https://api.youverify.co/v2/api/addresses/candidates/identity \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"type": "bvn",
"idNumber": "00000000000",
"subjectConsent": true
}
'import requests
url = "https://api.youverify.co/v2/api/addresses/candidates/identity"
payload = {
"type": "bvn",
"idNumber": "00000000000",
"subjectConsent": True
}
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({type: 'bvn', idNumber: '00000000000', subjectConsent: true})
};
fetch('https://api.youverify.co/v2/api/addresses/candidates/identity', 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/identity",
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([
'type' => 'bvn',
'idNumber' => '00000000000',
'subjectConsent' => true
]),
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/candidates/identity"
payload := strings.NewReader("{\n \"type\": \"bvn\",\n \"idNumber\": \"00000000000\",\n \"subjectConsent\": true\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/candidates/identity")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"bvn\",\n \"idNumber\": \"00000000000\",\n \"subjectConsent\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.youverify.co/v2/api/addresses/candidates/identity")
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 \"type\": \"bvn\",\n \"idNumber\": \"00000000000\",\n \"subjectConsent\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 201,
"message": "Candidate created successfully!",
"data": {
"firstName": "Peter",
"middleName": "Phillip",
"lastName": "Uche",
"dateOfBirth": "1950-02-04",
"photo": "data:image/jpg;base64,...",
"email": null,
"mobile": "08000000000",
"idNumber": "00000000000",
"type": "bvn",
"medium": "identity",
"createdAt": "2021-11-05T07:56:48.953Z",
"lastModifiedAt": "2021-11-05T07:56:48.953Z",
"id": "6184e3c081ee238921cb9e86"
},
"links": []
}{
"success": false,
"statusCode": 401,
"message": "Permission denied",
"name": "UnauthorizedError",
"data": {}
}{
"success": false,
"statusCode": 402,
"message": "Insufficient fund",
"name": "PaymentRequiredError",
"data": {}
}{
"success": false,
"statusCode": 429,
"message": "Too many requests",
"name": "RateLimitError",
"data": {}
}{
"success": false,
"statusCode": 500,
"message": "Internal Server Error",
"name": "Error",
"data": {}
}