Activity Management
Get Verification Types
Returns the list of supported verification/document types per country, along with their billing IDs and required permissions.
GET
/
v2
/
api
/
activities
/
verification-types
Get Verification Types
curl --request GET \
--url https://api.youverify.co/v2/api/activities/verification-types \
--header 'token: <api-key>'import requests
url = "https://api.youverify.co/v2/api/activities/verification-types"
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/activities/verification-types', 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/activities/verification-types",
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/activities/verification-types"
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/activities/verification-types")
.header("token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.youverify.co/v2/api/activities/verification-types")
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": "Business Metrics returned successfully",
"data": {
"NG": {
"name": "Nigeria",
"documents": [
{
"code": "bvn",
"label": "Bank Verification Number",
"billingId": [
"kyc_bvn",
"kyc_premium_bvn"
],
"permission": [
"identity:bvn:verify"
]
},
{
"code": "drivers_license",
"label": "Drivers License",
"billingId": [
"kyc_drivers_license"
],
"permission": [
"identity:ndl:verify"
]
},
{
"code": "vnin",
"label": "Virtual National Identification Number",
"billingId": [
"kyc_vnin"
],
"permission": [
"identity:nin:verify"
]
},
{
"code": "nin",
"label": "National Identification Number",
"billingId": [
"kyc_nin"
],
"permission": [
"identity:nin:verify"
]
},
{
"code": "passport",
"label": "Passport",
"billingId": [
"kyc_passport"
],
"permission": [
"identity:passport:verify"
]
},
{
"code": "pvc",
"label": "Permanent Voter's Card",
"billingId": [
"kyc_inec"
],
"permission": [
"identity:pvc:verify"
]
},
{
"code": "bav",
"label": "Bank Account Verification",
"billingId": [
"kyc_bav",
"kyc_ng_premium_bav"
],
"permission": [
"identity:bav:verify"
]
},
{
"code": "phone",
"label": "Phone Number",
"billingId": [
"kyc_phonenumber"
],
"permission": [
"identity:phone:verify"
]
},
{
"code": "nin_phone",
"label": "NIN Phone Number",
"billingId": [
"kyc_nin"
],
"permission": [
"identity:nin:verify"
]
}
]
},
"GH": {
"name": "Ghana",
"documents": [
{
"code": "new_voter_card",
"label": "Voter's ID",
"billingId": [
"kyc_gh_voter"
],
"permission": [
"identity:gh-voter:verify"
]
},
{
"code": "old_voter_card",
"label": "Old Voter's ID",
"billingId": [
"kyc_gh_voter"
],
"permission": [
"identity:gh-voter:verify"
]
},
{
"code": "passport",
"label": "Ghana Passport",
"billingId": [
"kyc_gh_passport"
],
"permission": [
"identity:gh-passport:verify"
]
},
{
"code": "drivers_license",
"label": "Ghana Driver License"
}
]
},
"KE": {
"name": "Kenya",
"documents": [
{
"code": "national-id",
"label": "Kenya National ID",
"billingId": [
"kyc_ke_national_id_v2"
],
"permission": [
"identity:ke-national-id:verify"
]
},
{
"code": "passport",
"label": "Kenya Passport",
"billingId": [
"kyc_ke_passport"
],
"permission": [
"identity:ke-passport:verify"
]
},
{
"code": "alien-id",
"label": "Kenya Alien ID",
"billingId": [
"kyc_ke_alien_id"
],
"permission": [
"identity:ke-alien-id:verify"
]
},
{
"code": "drivers-license",
"label": "Kenya Drivers License",
"billingId": [
"kyc_ke_drivers_license_v2"
],
"permission": [
"identity:ke-driver-license:verify"
]
}
]
},
"ZA": {
"name": "South Africa",
"documents": [
{
"code": "said",
"label": "South Africa National Identity",
"billingId": [
"kyc_za_id"
],
"permission": [
"identity:za-national-id:verify"
]
},
{
"code": "bav",
"label": "Bank Account Verification",
"billingId": [
"kyc_za_bav"
],
"permission": [
"identity:za-bav:validation"
]
}
]
}
}
}{
"success": false,
"statusCode": 401,
"message": "Permission denied",
"name": "UnauthorizedError",
"data": {}
}{
"success": false,
"statusCode": 404,
"message": "You have attempted to get a resource that does not exist.",
"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": {}
}⌘I
Get Verification Types
curl --request GET \
--url https://api.youverify.co/v2/api/activities/verification-types \
--header 'token: <api-key>'import requests
url = "https://api.youverify.co/v2/api/activities/verification-types"
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/activities/verification-types', 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/activities/verification-types",
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/activities/verification-types"
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/activities/verification-types")
.header("token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.youverify.co/v2/api/activities/verification-types")
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": "Business Metrics returned successfully",
"data": {
"NG": {
"name": "Nigeria",
"documents": [
{
"code": "bvn",
"label": "Bank Verification Number",
"billingId": [
"kyc_bvn",
"kyc_premium_bvn"
],
"permission": [
"identity:bvn:verify"
]
},
{
"code": "drivers_license",
"label": "Drivers License",
"billingId": [
"kyc_drivers_license"
],
"permission": [
"identity:ndl:verify"
]
},
{
"code": "vnin",
"label": "Virtual National Identification Number",
"billingId": [
"kyc_vnin"
],
"permission": [
"identity:nin:verify"
]
},
{
"code": "nin",
"label": "National Identification Number",
"billingId": [
"kyc_nin"
],
"permission": [
"identity:nin:verify"
]
},
{
"code": "passport",
"label": "Passport",
"billingId": [
"kyc_passport"
],
"permission": [
"identity:passport:verify"
]
},
{
"code": "pvc",
"label": "Permanent Voter's Card",
"billingId": [
"kyc_inec"
],
"permission": [
"identity:pvc:verify"
]
},
{
"code": "bav",
"label": "Bank Account Verification",
"billingId": [
"kyc_bav",
"kyc_ng_premium_bav"
],
"permission": [
"identity:bav:verify"
]
},
{
"code": "phone",
"label": "Phone Number",
"billingId": [
"kyc_phonenumber"
],
"permission": [
"identity:phone:verify"
]
},
{
"code": "nin_phone",
"label": "NIN Phone Number",
"billingId": [
"kyc_nin"
],
"permission": [
"identity:nin:verify"
]
}
]
},
"GH": {
"name": "Ghana",
"documents": [
{
"code": "new_voter_card",
"label": "Voter's ID",
"billingId": [
"kyc_gh_voter"
],
"permission": [
"identity:gh-voter:verify"
]
},
{
"code": "old_voter_card",
"label": "Old Voter's ID",
"billingId": [
"kyc_gh_voter"
],
"permission": [
"identity:gh-voter:verify"
]
},
{
"code": "passport",
"label": "Ghana Passport",
"billingId": [
"kyc_gh_passport"
],
"permission": [
"identity:gh-passport:verify"
]
},
{
"code": "drivers_license",
"label": "Ghana Driver License"
}
]
},
"KE": {
"name": "Kenya",
"documents": [
{
"code": "national-id",
"label": "Kenya National ID",
"billingId": [
"kyc_ke_national_id_v2"
],
"permission": [
"identity:ke-national-id:verify"
]
},
{
"code": "passport",
"label": "Kenya Passport",
"billingId": [
"kyc_ke_passport"
],
"permission": [
"identity:ke-passport:verify"
]
},
{
"code": "alien-id",
"label": "Kenya Alien ID",
"billingId": [
"kyc_ke_alien_id"
],
"permission": [
"identity:ke-alien-id:verify"
]
},
{
"code": "drivers-license",
"label": "Kenya Drivers License",
"billingId": [
"kyc_ke_drivers_license_v2"
],
"permission": [
"identity:ke-driver-license:verify"
]
}
]
},
"ZA": {
"name": "South Africa",
"documents": [
{
"code": "said",
"label": "South Africa National Identity",
"billingId": [
"kyc_za_id"
],
"permission": [
"identity:za-national-id:verify"
]
},
{
"code": "bav",
"label": "Bank Account Verification",
"billingId": [
"kyc_za_bav"
],
"permission": [
"identity:za-bav:validation"
]
}
]
}
}
}{
"success": false,
"statusCode": 401,
"message": "Permission denied",
"name": "UnauthorizedError",
"data": {}
}{
"success": false,
"statusCode": 404,
"message": "You have attempted to get a resource that does not exist.",
"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": {}
}