KYC - South Africa
Verify South African Phone Number
Verifies that a provided South African phone number exists in the database and retrieves associated information.
POST
/
v2
/
api
/
identity
/
za
/
phone
Verify South African Phone Number
curl --request POST \
--url https://api.youverify.co/v2/api/identity/za/phone \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"phoneNumber": "821112110",
"phoneCountryCode": "+27",
"isSubjectConsent": true
}
'import requests
url = "https://api.youverify.co/v2/api/identity/za/phone"
payload = {
"phoneNumber": "821112110",
"phoneCountryCode": "+27",
"isSubjectConsent": 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({phoneNumber: '821112110', phoneCountryCode: '+27', isSubjectConsent: true})
};
fetch('https://api.youverify.co/v2/api/identity/za/phone', 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/identity/za/phone",
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([
'phoneNumber' => '821112110',
'phoneCountryCode' => '+27',
'isSubjectConsent' => 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/identity/za/phone"
payload := strings.NewReader("{\n \"phoneNumber\": \"821112110\",\n \"phoneCountryCode\": \"+27\",\n \"isSubjectConsent\": 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/identity/za/phone")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"phoneNumber\": \"821112110\",\n \"phoneCountryCode\": \"+27\",\n \"isSubjectConsent\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.youverify.co/v2/api/identity/za/phone")
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 \"phoneNumber\": \"821112110\",\n \"phoneCountryCode\": \"+27\",\n \"isSubjectConsent\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 200,
"message": "success",
"data": {
"id": "645bca00d80de606cd7e5acf",
"parentId": null,
"status": "found",
"reason": null,
"dataValidation": false,
"selfieValidation": false,
"phoneCountryCode": "27",
"mobile": "+27821112110",
"phoneNumber": "821112110",
"phoneTypeCode": "2",
"phoneTypeDescription": "MOBILE",
"phoneCity": "Countrywide",
"phoneState": null,
"phoneZip": null,
"phoneCounty": null,
"phoneCountry": "South Africa",
"phoneCountryCodeISO2": "ZA",
"phoneCountryCodeISO3": "ZAF",
"carrier": "Vodacom SA",
"isPhoneBlocked": false,
"phoneBlockCode": "0",
"phoneBlockDescription": "Not blocked",
"phoneRiskLevel": "medium-low",
"phoneRiskScore": "300",
"phoneRiskRecommendation": null,
"isBlacklistedCountryCode": "NA",
"isBlackListedPhoneNumber": "NA",
"isBlackListedPhoneType": "NA",
"isPhoneNumberValid": true,
"phoneRiskOutcome": "Medium",
"isConsent": true,
"idNumber": "821112110",
"businessId": "628b38f03ae28a14f52d4bf7",
"type": "zaPhone",
"allValidationPassed": true,
"requestedAt": "2023-05-10T16:44:56.417Z",
"requestedById": "628b38f13ae28a7b742d4bf9",
"country": "ZA",
"createdAt": "2023-05-10T16:44:56.822Z",
"lastModifiedAt": "2023-05-10T16:44:56.822Z",
"metadata": {},
"requestedBy": {
"firstName": "Onyeka",
"lastName": "Ijeh",
"middleName": "",
"id": "628b38f13ae28a7b742d4bf9"
}
},
"links": []
}{
"success": false,
"statusCode": 401,
"message": "Permission denied",
"name": "UnauthorizedError",
"data": {}
}{
"success": false,
"statusCode": 402,
"message": "Insufficient fund",
"name": "PaymentRequiredError",
"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": {}
}Authorizations
Your Youverify API secret key. Never expose client-side.
Headers
API secret token
Body
application/json
Response
Success
⌘I
Verify South African Phone Number
curl --request POST \
--url https://api.youverify.co/v2/api/identity/za/phone \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"phoneNumber": "821112110",
"phoneCountryCode": "+27",
"isSubjectConsent": true
}
'import requests
url = "https://api.youverify.co/v2/api/identity/za/phone"
payload = {
"phoneNumber": "821112110",
"phoneCountryCode": "+27",
"isSubjectConsent": 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({phoneNumber: '821112110', phoneCountryCode: '+27', isSubjectConsent: true})
};
fetch('https://api.youverify.co/v2/api/identity/za/phone', 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/identity/za/phone",
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([
'phoneNumber' => '821112110',
'phoneCountryCode' => '+27',
'isSubjectConsent' => 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/identity/za/phone"
payload := strings.NewReader("{\n \"phoneNumber\": \"821112110\",\n \"phoneCountryCode\": \"+27\",\n \"isSubjectConsent\": 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/identity/za/phone")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"phoneNumber\": \"821112110\",\n \"phoneCountryCode\": \"+27\",\n \"isSubjectConsent\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.youverify.co/v2/api/identity/za/phone")
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 \"phoneNumber\": \"821112110\",\n \"phoneCountryCode\": \"+27\",\n \"isSubjectConsent\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 200,
"message": "success",
"data": {
"id": "645bca00d80de606cd7e5acf",
"parentId": null,
"status": "found",
"reason": null,
"dataValidation": false,
"selfieValidation": false,
"phoneCountryCode": "27",
"mobile": "+27821112110",
"phoneNumber": "821112110",
"phoneTypeCode": "2",
"phoneTypeDescription": "MOBILE",
"phoneCity": "Countrywide",
"phoneState": null,
"phoneZip": null,
"phoneCounty": null,
"phoneCountry": "South Africa",
"phoneCountryCodeISO2": "ZA",
"phoneCountryCodeISO3": "ZAF",
"carrier": "Vodacom SA",
"isPhoneBlocked": false,
"phoneBlockCode": "0",
"phoneBlockDescription": "Not blocked",
"phoneRiskLevel": "medium-low",
"phoneRiskScore": "300",
"phoneRiskRecommendation": null,
"isBlacklistedCountryCode": "NA",
"isBlackListedPhoneNumber": "NA",
"isBlackListedPhoneType": "NA",
"isPhoneNumberValid": true,
"phoneRiskOutcome": "Medium",
"isConsent": true,
"idNumber": "821112110",
"businessId": "628b38f03ae28a14f52d4bf7",
"type": "zaPhone",
"allValidationPassed": true,
"requestedAt": "2023-05-10T16:44:56.417Z",
"requestedById": "628b38f13ae28a7b742d4bf9",
"country": "ZA",
"createdAt": "2023-05-10T16:44:56.822Z",
"lastModifiedAt": "2023-05-10T16:44:56.822Z",
"metadata": {},
"requestedBy": {
"firstName": "Onyeka",
"lastName": "Ijeh",
"middleName": "",
"id": "628b38f13ae28a7b742d4bf9"
}
},
"links": []
}{
"success": false,
"statusCode": 401,
"message": "Permission denied",
"name": "UnauthorizedError",
"data": {}
}{
"success": false,
"statusCode": 402,
"message": "Insufficient fund",
"name": "PaymentRequiredError",
"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": {}
}