To request a Facematch Verification (combination of documents and liveness), the following end point will return the unique URL for your end user to navigate to in order to complete the verification process.
To request a Facematch, make a HTTPS POST request to https://api.lemverify.io/api/v1/{account_id}/combination, where {account_id} is your LEM Verify account ID found in the Account Setup section of the dashboard.
The body must contain the following parameters:
| Field | Type | Required | Notes |
|---|---|---|---|
| clientRef | String | Mandatory | A String containing your own unique client reference number |
| redactMe | Boolean | Optional. Default is false | If set to true the documents will be redacted as per your settings |
| amlRequired | Boolean | Optional. Default is false | If set to true an AML report will be generated, if enabled, as per your settings. |
| requestSmartsearchReport | Boolean | Optional. Default is true | If this override is set to false the system will not request a SmartSearch report, even if SmartSearch is enabled as default. |
| sendEmail | String | Optional | If you wish to also send an email (standard LEM content through the LEM email server) to a recipient please include a validated email address. The API will not validate the email address you supply. |
| sendSms | String | Optional | If you wish to also send an SMS (standard LEM content through the LEM SMS server) to a recipient please include a validated SMS number (with the country code, for example +44788xxxxxxx). The API will not validate the SMS number you supply. |
If the request is successful (200 response) then the response body will look similar to the following:
{
"id": "8a20ab90-37a1-11e9-a79c-891da1f19982",
"friendlyId": "vVebr9keyfZ2sctoZkMfBG",
"url": "https://lemverify.io/combination_verification.html?acc=gc15f4xa-8ea5-4b7e-94c0-cd0303d80aed",
"balance": 52,
"deliveryMethods": [
"API",
]
}
The deliveryMethods array returns the transmission methods used in this request and will always contain "API". If an email was also sent this array will contain "EMAIL". If an SMS was also sent this array will contain "SMS".
The id is a UUID for the verification, the friendlyId is a short uuid (mostly used for internal referencing at LEM), the balance is remaining credit balance on the LEM Verify account and the url is the url containing the unique URL for the verification (where the documents and liveness secure verification takes place).
Considerations
The request will stay in the pending state for 30 days, until either the verification is completed or has been deleted via the LEM Verify dashboard.
Once a verification is completed it will be retained in the LEM Verify system for 7 days, where it will then be permanently deleted.