Driver’s License Boolean Match

The Drivers License Number Verification service is used to verify the authenticity of a driver's Licence Number by matching a License Number against the last name and date of birth.

Overview

The Drivers License Boolean Match Verification service accepts the Drivers License Number, countryCode, Date of Birth from the customer and returns detailed information when the details are matched with the database. This article will guide you on how to integrate to this Service.

🚧

Important!

Before you proceed, ensure you review the prerequisites for integrating to our APIs for a more detailed guide.

API Endpoint

https://api.verified.africa/sfx-verify/v3/id-service/

Headers

Our service accepts headers for authentication. See below the headers to pass to the API

Header	Type	Description
userid	String	This is your user id retrieved from the portal. Check the getting started article to understand how to retrieve your userid
apiKey	String	This is your api key retrieved from the portal. Check the getting started article to understand how to retrieve your apiKey

Request

Request Parameter	Description	Description	Test Data
countryCode	Optional	The countryCode will be passed into this field	NG
firstName	Required	The firstName will be passed into this field	John
lastName	Required	The lastName will be passed into this field	Doe
dob	Required	The date of birth will be passed into this field	1988-04-04
searchParameter	Required	The Drivers License Number will be passed into this field	AAA00000AA00
verificationType	Required	This field is used to identify the service being called. Ensure to use the value provided exactly as provided	DRIVER-LICENSE-BOOLEAN-MATCH-VERIFICATION

Driver's License Boolean Match Request Sample

{
    "countryCode": "NG",
    "firstName":"John",
    "lastName":"Doe",
    "dob":"1988-04-04",
    "searchParameter":"AAA00000AA00",
    "verificationType": "DRIVER-LICENSE-BOOLEAN-MATCH-VERIFICATION"
}

Response

Response Parameter	Type	Description
responseCode	String	Please reference Response Codes page for details on all possible response
description	String	This is a description of the response received.
verificationType	String	The same verificationType passed in request will be returned here
verificationStatus	String	This field lets you know if the identity verification was successful. Options are: VERIFIED: This means that the Voters Card Number is valid. NOT VERIFIED This means that the Voters Card Number is invalid PENDING This status means that the verification could not be completed. Refer to the responseCode for the specific failure reason
transactionStatus	String	This indicates the wallet debit status. The options are successful or failed.
transactionReference	String	If you supplied a transactionReference, the same will be returned here. Else, we would generate a reference and return that to you in this field.
transactionDate	String	Date the transaction was done
searchParameter	String	Drivers License Number used for the verification
response	Json	This is a json containing all the actual NIN data as retrieved from the service provider.

Driver's License Boolean Match Response Sample

{
    "responseCode": "00",
    "description": "Successful",
    "verificationType": "DRIVER-LICENSE-BOOLEAN-MATCH-VERIFICATION",
    "verificationStatus": "VERIFIED",
    "transactionStatus": "SUCCESSFUL",
    "transactionReference": "1628016393774-LA0UN5OK",
    "transactionDate": "1667466742100",
    "searchParameter": "AAA00000AA00",
    "callBackUrl": null,
    "livenessScore": 0.0,
    "paymentRef": null,
    "response": null,
    "faceMatch": null
}