Initiate Liveness Check
curl --request POST \
--url https://waas-staging.embedly.ng/api/v1/customers/kyc/liveliness \
--header 'x-api-key: <api-key>'import requests
url = "https://waas-staging.embedly.ng/api/v1/customers/kyc/liveliness"
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/customers/kyc/liveliness', 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/customers/kyc/liveliness",
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/customers/kyc/liveliness"
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/customers/kyc/liveliness")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://waas-staging.embedly.ng/api/v1/customers/kyc/liveliness")
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
Initiate Liveness Check
Start a HyperVerge liveness session for customer KYC.
POST
/
api
/
v1
/
customers
/
kyc
/
liveliness
Initiate Liveness Check
curl --request POST \
--url https://waas-staging.embedly.ng/api/v1/customers/kyc/liveliness \
--header 'x-api-key: <api-key>'import requests
url = "https://waas-staging.embedly.ng/api/v1/customers/kyc/liveliness"
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/customers/kyc/liveliness', 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/customers/kyc/liveliness",
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/customers/kyc/liveliness"
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/customers/kyc/liveliness")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://waas-staging.embedly.ng/api/v1/customers/kyc/liveliness")
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 begins the liveness portion of the customer KYC flow. It does not complete verification directly; instead it returns a
Success response —
startKycUrl that must be opened in a browser or webview so the customer can submit their selfie to HyperVerge. The result is delivered asynchronously via webhook and reflected in the customer’s liveness status.
Endpoint
POST /api/v1/customers/kyc/liveliness
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 to verify. Must belong to the authenticated organization. |
submissionChannel | string enum | no | Source of the request. Allowed: WAAS (default), MERCHANT_SERVICE. Frontends calling WaaS Core directly should omit this or send WAAS. |
redirectUrl | string (URL) | no | The URL to redirect the customer to after completing the liveness check. Invalid/relative URLs are rejected with 400. Omit to use HyperVerge’s default post capture behavior. |
{
"customerId": "8d3e2c4a-19b7-4f2e-9c61-2a78b0f31c45",
"submissionChannel": "WAAS",
"redirectUrl": "https://example.com/redirect"
}
Success response — 200 OK
{
"code": "00",
"success": true,
"message": "Operation Successful",
"data": {
"customerId": "8d3e2c4a-19b7-4f2e-9c61-2a78b0f31c45",
"startKycUrl": "https://hyperverge.co/kyc/xyz789?token=…",
"status": "in_progress",
"requestId": "hv-trn-9f8e7d6c5b4a",
"attemptNumber": 1,
"channel": "WAAS"
}
}
Error responses
| Status | Trigger | Sample body |
|---|---|---|
400 | customerId missing / invalid GUID | {"code":"400","success":false,"message":"customerId is required","data":null} |
400 | Unknown submissionChannel | {"code":"400","success":false,"message":"submissionChannel 'X' is not accepted. Allowed values: WAAS, MERCHANT_SERVICE","data":null} |
404 | Customer not found | {"code":"404","success":false,"message":"The customer could not be found","data":null} |
422 | Liveness not enabled | {"code":"422","success":false,"message":"Liveness verification is not enabled for this organization","data":null} |
422 | NIN/BVN not verified | {"code":"422","success":false,"message":"NIN/BVN verification must be completed before initiating liveness","data":null} |
409 | Already completed | {"code":"409","success":false,"message":"This customer has already completed liveness verification successfully. Re-initiation is not permitted.","data":null} |
502 | HyperVerge failure | {"code":"502","success":false,"message":"Could not generate liveness URL. Please retry shortly.","data":null} |
500 | Unexpected | {"code":"500","success":false,"message":"An unexpected error occurred while initiating liveness","data":null} |
⌘I