Generating Tokens
POST /initiate_finger_verification_sdk
Description
The /initiate_finger_verification_sdk endpoint serves as the designated pathway for generating tokens required for fingerprint verifications.
Required Body Paramaters
id_number: This is a string representing the Ghana Card number of the individual being verified.
It should follow the formatGHA-XXXXXXXXX-Xwhere X represents a digit.referenceid: This is a string that can be used to track this verification; example being the client's phone number.purpose (optional): This is an optional string describing the purpose for the verification, eg. "Account opening KYC".branch_name (optional): This is an optional string that can be used to track the branch that is tied to this verification.
- Example Request
- Example Response
curl -X POST "https://service-prod.metric.africa/api/fingerprint/initiate_finger_verification_sdk" \
-H "Content-Type: application/json" \
-H "X-API-AUTH: abcdefghijklmnopqrstuvwxyz" \
-d '{
"purpose": "Account opening KYC",
"branch_name": "Accra - HQ",
"id_number": "GHA-002308528-4",
"referenceid": "0541504140"
}'
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "Fingerprint session started successfully",
"data": {
"token": "X7Q3BMSAB"
}
}