Domestic AML check
curl --request POST \
--url https://api.hyparrow.cloud/api/v1/kyc/verify/aml/domestic \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"fullName": "John Ade Doe"
}
'import requests
url = "https://api.hyparrow.cloud/api/v1/kyc/verify/aml/domestic"
payload = { "fullName": "John Ade Doe" }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({fullName: 'John Ade Doe'})
};
fetch('https://api.hyparrow.cloud/api/v1/kyc/verify/aml/domestic', 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.hyparrow.cloud/api/v1/kyc/verify/aml/domestic",
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([
'fullName' => 'John Ade Doe'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <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.hyparrow.cloud/api/v1/kyc/verify/aml/domestic"
payload := strings.NewReader("{\n \"fullName\": \"John Ade Doe\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<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.hyparrow.cloud/api/v1/kyc/verify/aml/domestic")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fullName\": \"John Ade Doe\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyparrow.cloud/api/v1/kyc/verify/aml/domestic")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fullName\": \"John Ade Doe\"\n}"
response = http.request(request)
puts response.read_body{
"data": {},
"success": true
}{
"code": "VALIDATION_ERROR",
"error": "bvn must be exactly 11 digits",
"field": "bvn",
"success": false
}{
"code": "INSUFFICIENT_BALANCE",
"error": "Insufficient verification balance",
"success": false
}{
"code": "INSUFFICIENT_BALANCE",
"error": "Insufficient verification balance",
"success": false
}{
"code": "RECORD_NOT_FOUND",
"data": {
"message": "Invalid BVN or BVN does not exist"
},
"error": "no record was found for the details provided",
"success": false
}{
"code": "UPSTREAM_ERROR",
"data": {
"message": "Invalid BVN or BVN does not exist"
},
"error": "the verification network is temporarily unavailable",
"success": false
}KYC
Domestic AML check
Runs a domestic anti-money-laundering (AML) screening on a full name.
POST
/
kyc
/
verify
/
aml
/
domestic
Domestic AML check
curl --request POST \
--url https://api.hyparrow.cloud/api/v1/kyc/verify/aml/domestic \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"fullName": "John Ade Doe"
}
'import requests
url = "https://api.hyparrow.cloud/api/v1/kyc/verify/aml/domestic"
payload = { "fullName": "John Ade Doe" }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({fullName: 'John Ade Doe'})
};
fetch('https://api.hyparrow.cloud/api/v1/kyc/verify/aml/domestic', 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.hyparrow.cloud/api/v1/kyc/verify/aml/domestic",
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([
'fullName' => 'John Ade Doe'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <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.hyparrow.cloud/api/v1/kyc/verify/aml/domestic"
payload := strings.NewReader("{\n \"fullName\": \"John Ade Doe\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<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.hyparrow.cloud/api/v1/kyc/verify/aml/domestic")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fullName\": \"John Ade Doe\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyparrow.cloud/api/v1/kyc/verify/aml/domestic")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fullName\": \"John Ade Doe\"\n}"
response = http.request(request)
puts response.read_body{
"data": {},
"success": true
}{
"code": "VALIDATION_ERROR",
"error": "bvn must be exactly 11 digits",
"field": "bvn",
"success": false
}{
"code": "INSUFFICIENT_BALANCE",
"error": "Insufficient verification balance",
"success": false
}{
"code": "INSUFFICIENT_BALANCE",
"error": "Insufficient verification balance",
"success": false
}{
"code": "RECORD_NOT_FOUND",
"data": {
"message": "Invalid BVN or BVN does not exist"
},
"error": "no record was found for the details provided",
"success": false
}{
"code": "UPSTREAM_ERROR",
"data": {
"message": "Invalid BVN or BVN does not exist"
},
"error": "the verification network is temporarily unavailable",
"success": false
}⌘I

