Submit ID Card Document
curl --request POST \
--url https://waas-staging.embedly.ng/api/v1/api/v1/customers/kyc/id-card \
--header 'x-api-key: <api-key>'import requests
url = "https://waas-staging.embedly.ng/api/v1/api/v1/customers/kyc/id-card"
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
fetch('https://waas-staging.embedly.ng/api/v1/api/v1/customers/kyc/id-card', 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/v1/api/v1/customers/kyc/id-card",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://waas-staging.embedly.ng/api/v1/api/v1/customers/kyc/id-card"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-api-key", "<api-key>")
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/v1/api/v1/customers/kyc/id-card")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://waas-staging.embedly.ng/api/v1/api/v1/customers/kyc/id-card")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_bodyKYC
Submit ID Card Document
Submit an ID-card document URL for back-office review during customer KYC.
POST
/
api
/
v1
/
customers
/
kyc
/
id-card
Submit ID Card Document
curl --request POST \
--url https://waas-staging.embedly.ng/api/v1/api/v1/customers/kyc/id-card \
--header 'x-api-key: <api-key>'import requests
url = "https://waas-staging.embedly.ng/api/v1/api/v1/customers/kyc/id-card"
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
fetch('https://waas-staging.embedly.ng/api/v1/api/v1/customers/kyc/id-card', 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/v1/api/v1/customers/kyc/id-card",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://waas-staging.embedly.ng/api/v1/api/v1/customers/kyc/id-card"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-api-key", "<api-key>")
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/v1/api/v1/customers/kyc/id-card")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://waas-staging.embedly.ng/api/v1/api/v1/customers/kyc/id-card")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_bodyThis endpoint records an ID-card document that has already been uploaded to a secure HTTPS URL. It does not accept raw file uploads. Use this after liveness has completed and the customer is ready to submit their document for back-office review.
Endpoint
POST /api/v1/customers/kyc/id-card
Headers
| Header | Value |
|---|---|
Content-Type | application/json |
x-api-key | <tenant API key> |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
customerId | string (GUID) | yes | The customer the document belongs to. Must be on Tier 2 (NIN + BVN verified + liveness completed). |
documentType | string enum | yes | Allowed: NIN_CARD, DRIVERS_LICENCE, PASSPORT, VOTERS_CARD. Case-insensitive on input; normalised on output. |
documentUrl | string (HTTPS URL) | yes | Must use https://. Plain http:// is rejected. The URL is stored verbatim; the back office presigns / fetches it during review. |
submissionChannel | string enum | no | Source of the request. Allowed: WAAS (default), MERCHANT_SERVICE. |
{
"customerId": "8d3e2c4a-19b7-4f2e-9c61-2a78b0f31c45",
"documentType": "NIN_CARD",
"documentUrl": "https://your-cdn.example.com/uploads/nin-card-8d3e.jpg",
"submissionChannel": "WAAS"
}
Success response
{
"code": "00",
"success": true,
"message": "ID card submitted successfully and is pending review",
"data": {
"customerId": "8d3e2c4a-19b7-4f2e-9c61-2a78b0f31c45",
"submissionId": "DOC-SUB-00001",
"documentType": "NIN_CARD",
"documentUrl": "https://your-cdn.example.com/uploads/nin-card-8d3e.jpg",
"status": "pending_review",
"submittedAt": "2026-06-25T10:14:33.521Z",
"attemptNumber": 1,
"channel": "WAAS"
}
}
Error responses
| Status | Trigger | Sample body |
|---|---|---|
400 | Invalid GUID | {"code":"400","success":false,"message":"customerId must be a valid GUID","data":null} |
400 | Unknown documentType | {"code":"400","success":false,"message":"documentType 'X' is not accepted. Allowed values: NIN_CARD, DRIVERS_LICENCE, PASSPORT, VOTERS_CARD","data":null} |
400 | documentUrl not HTTPS | {"code":"400","success":false,"message":"documentUrl must use HTTPS","data":null} |
404 | Customer not found | {"code":"404","success":false,"message":"The customer could not be found","data":null} |
422 | NIN/BVN not verified | {"code":"422","success":false,"message":"NIN and BVN verification must be completed before an ID card can be submitted","data":null} |
422 | Tier below 2 | {"code":"422","success":false,"message":"Customer must be on Tier 2 before submitting an ID card","data":null} |
409 | Submission pending | {"code":"409","success":false,"message":"A document submission is already under review. Re-upload is only permitted after current review completes.","data":null} |
409 | Already approved | {"code":"409","success":false,"message":"This customer's ID card has already been approved. No further submission is required.","data":null} |
500 | Unexpected | {"code":"500","success":false,"message":"An unexpected error occurred while submitting the ID card","data":null} |
⌘I