Customer KYC Upgrade - Address Verification (V2)
curl --request POST \
--url https://waas-staging.embedly.ng/api/v2/customers/kyc/address-verification \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"customerId": "<string>",
"flatNumber": "<string>",
"buildingNumber": "<string>",
"street": "<string>",
"state": "<string>",
"city": "<string>",
"country": "<string>",
"landmark": "<string>",
"image": "<string>",
"imageContentType": "<string>",
"customerNumber": "<string>",
"ledgerCode": "<string>",
"nuban": "<string>"
}
'import requests
url = "https://waas-staging.embedly.ng/api/v2/customers/kyc/address-verification"
payload = {
"customerId": "<string>",
"flatNumber": "<string>",
"buildingNumber": "<string>",
"street": "<string>",
"state": "<string>",
"city": "<string>",
"country": "<string>",
"landmark": "<string>",
"image": "<string>",
"imageContentType": "<string>",
"customerNumber": "<string>",
"ledgerCode": "<string>",
"nuban": "<string>"
}
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({
customerId: '<string>',
flatNumber: '<string>',
buildingNumber: '<string>',
street: '<string>',
state: '<string>',
city: '<string>',
country: '<string>',
landmark: '<string>',
image: '<string>',
imageContentType: '<string>',
customerNumber: '<string>',
ledgerCode: '<string>',
nuban: '<string>'
})
};
fetch('https://waas-staging.embedly.ng/api/v2/customers/kyc/address-verification', 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://waas-staging.embedly.ng/api/v2/customers/kyc/address-verification",
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([
'customerId' => '<string>',
'flatNumber' => '<string>',
'buildingNumber' => '<string>',
'street' => '<string>',
'state' => '<string>',
'city' => '<string>',
'country' => '<string>',
'landmark' => '<string>',
'image' => '<string>',
'imageContentType' => '<string>',
'customerNumber' => '<string>',
'ledgerCode' => '<string>',
'nuban' => '<string>'
]),
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://waas-staging.embedly.ng/api/v2/customers/kyc/address-verification"
payload := strings.NewReader("{\n \"customerId\": \"<string>\",\n \"flatNumber\": \"<string>\",\n \"buildingNumber\": \"<string>\",\n \"street\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"landmark\": \"<string>\",\n \"image\": \"<string>\",\n \"imageContentType\": \"<string>\",\n \"customerNumber\": \"<string>\",\n \"ledgerCode\": \"<string>\",\n \"nuban\": \"<string>\"\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://waas-staging.embedly.ng/api/v2/customers/kyc/address-verification")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customerId\": \"<string>\",\n \"flatNumber\": \"<string>\",\n \"buildingNumber\": \"<string>\",\n \"street\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"landmark\": \"<string>\",\n \"image\": \"<string>\",\n \"imageContentType\": \"<string>\",\n \"customerNumber\": \"<string>\",\n \"ledgerCode\": \"<string>\",\n \"nuban\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://waas-staging.embedly.ng/api/v2/customers/kyc/address-verification")
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 \"customerId\": \"<string>\",\n \"flatNumber\": \"<string>\",\n \"buildingNumber\": \"<string>\",\n \"street\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"landmark\": \"<string>\",\n \"image\": \"<string>\",\n \"imageContentType\": \"<string>\",\n \"customerNumber\": \"<string>\",\n \"ledgerCode\": \"<string>\",\n \"nuban\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"message": "Address verification completed successfully",
"referenceNumber": "ADDR_20260409112339_6c6ffb63",
"result": "Success"
},
"status": 200,
"message": ""
}
{
"data": {
"message": "Address verification failed",
"referenceNumber": "ADDR_20260409110211_12b106fa",
"error": "nnnodename nor servnameprovided or not known (hq-qa3-test.sterlingbank.com:9292)"
},
"status": 400,
"message": ""
}
KYC
Customer KYC Upgrade - Address Verification (V2)
This endpoint enables you to complete address verification for customer in order to upgrade the customer’s KYC to Tier 3
POST
/
api
/
v2
/
customers
/
kyc
/
address-verification
Customer KYC Upgrade - Address Verification (V2)
curl --request POST \
--url https://waas-staging.embedly.ng/api/v2/customers/kyc/address-verification \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"customerId": "<string>",
"flatNumber": "<string>",
"buildingNumber": "<string>",
"street": "<string>",
"state": "<string>",
"city": "<string>",
"country": "<string>",
"landmark": "<string>",
"image": "<string>",
"imageContentType": "<string>",
"customerNumber": "<string>",
"ledgerCode": "<string>",
"nuban": "<string>"
}
'import requests
url = "https://waas-staging.embedly.ng/api/v2/customers/kyc/address-verification"
payload = {
"customerId": "<string>",
"flatNumber": "<string>",
"buildingNumber": "<string>",
"street": "<string>",
"state": "<string>",
"city": "<string>",
"country": "<string>",
"landmark": "<string>",
"image": "<string>",
"imageContentType": "<string>",
"customerNumber": "<string>",
"ledgerCode": "<string>",
"nuban": "<string>"
}
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({
customerId: '<string>',
flatNumber: '<string>',
buildingNumber: '<string>',
street: '<string>',
state: '<string>',
city: '<string>',
country: '<string>',
landmark: '<string>',
image: '<string>',
imageContentType: '<string>',
customerNumber: '<string>',
ledgerCode: '<string>',
nuban: '<string>'
})
};
fetch('https://waas-staging.embedly.ng/api/v2/customers/kyc/address-verification', 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://waas-staging.embedly.ng/api/v2/customers/kyc/address-verification",
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([
'customerId' => '<string>',
'flatNumber' => '<string>',
'buildingNumber' => '<string>',
'street' => '<string>',
'state' => '<string>',
'city' => '<string>',
'country' => '<string>',
'landmark' => '<string>',
'image' => '<string>',
'imageContentType' => '<string>',
'customerNumber' => '<string>',
'ledgerCode' => '<string>',
'nuban' => '<string>'
]),
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://waas-staging.embedly.ng/api/v2/customers/kyc/address-verification"
payload := strings.NewReader("{\n \"customerId\": \"<string>\",\n \"flatNumber\": \"<string>\",\n \"buildingNumber\": \"<string>\",\n \"street\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"landmark\": \"<string>\",\n \"image\": \"<string>\",\n \"imageContentType\": \"<string>\",\n \"customerNumber\": \"<string>\",\n \"ledgerCode\": \"<string>\",\n \"nuban\": \"<string>\"\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://waas-staging.embedly.ng/api/v2/customers/kyc/address-verification")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customerId\": \"<string>\",\n \"flatNumber\": \"<string>\",\n \"buildingNumber\": \"<string>\",\n \"street\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"landmark\": \"<string>\",\n \"image\": \"<string>\",\n \"imageContentType\": \"<string>\",\n \"customerNumber\": \"<string>\",\n \"ledgerCode\": \"<string>\",\n \"nuban\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://waas-staging.embedly.ng/api/v2/customers/kyc/address-verification")
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 \"customerId\": \"<string>\",\n \"flatNumber\": \"<string>\",\n \"buildingNumber\": \"<string>\",\n \"street\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"landmark\": \"<string>\",\n \"image\": \"<string>\",\n \"imageContentType\": \"<string>\",\n \"customerNumber\": \"<string>\",\n \"ledgerCode\": \"<string>\",\n \"nuban\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"message": "Address verification completed successfully",
"referenceNumber": "ADDR_20260409112339_6c6ffb63",
"result": "Success"
},
"status": 200,
"message": ""
}
{
"data": {
"message": "Address verification failed",
"referenceNumber": "ADDR_20260409110211_12b106fa",
"error": "nnnodename nor servnameprovided or not known (hq-qa3-test.sterlingbank.com:9292)"
},
"status": 400,
"message": ""
}
The Embedly unique identifier of the customer whose KYC tier is being
upgraded. Example:
3fa85f64-5717-4562-b3fc-2c963f66afa6Flat/Unit number. Example:
12BBuilding number. Example:
8Street address. Example:
Professor Gabriel Olusanya StState. Example:
LagosCity. Example:
LekkiCountry. Example:
NigeriaNearest landmark. Example:
Lekki Phase 1 GateUse https://waas-staging.embedly.ng/api/v1/utilities/upload to generate a url
string. The image should be a clear photograph of a valid proof of address
document, such as a utility bill, bank statement, or government-issued
document that clearly shows the customer’s name and address. The image must be
in JPEG or PNG format and should not exceed 5MB in size. Example:
https://waas-staging.embedly.ng/uploads/kyc/addr_verification/1234567890.jpgImage MIME type. Example:
image/jpegCustomer number. Example:
CUST_000123Ledger code. Example:
LEDGER_001Customer NUBAN. Example:
1234567890{
"data": {
"message": "Address verification completed successfully",
"referenceNumber": "ADDR_20260409112339_6c6ffb63",
"result": "Success"
},
"status": 200,
"message": ""
}
{
"data": {
"message": "Address verification failed",
"referenceNumber": "ADDR_20260409110211_12b106fa",
"error": "nnnodename nor servnameprovided or not known (hq-qa3-test.sterlingbank.com:9292)"
},
"status": 400,
"message": ""
}
⌘I