Access Endpoint URL: https://rest.everyware.com/api/v1/identity-score/identity-verification-request [POST]
You can create a unique URL to create an ID document verification link in order to send to a consumer. You are able to specify the following in the call:
- ID document verification type - specify whether to require the consumer to provide only ID document without a liveness check (selfie) or with a liveness check.
- Specify link expiration (in days).
The response returns the unique link that can be sent to the consumer.
🚧 Contacts Must Be Created
A valid contact will be created when the Identity Match Request API is used. You can also create a contact with the CreateCustomer method or CreateInvoice method.
Inbound Parameters
Parameters should be passed in a single JSON-body object.
|
Parameter Name
|
Description
|
Optional/Required
|
|---|
|
phoneNumber
|
Phone number of payee (10-digits max, no formatting). Accepts both mobile/landline numbers.
Example: 3055551212
</td><td>
Required
</td></tr><tr><td>
idVerificationType
</td><td>
Type of ID document verification
* ID Document Verification with no liveness check = 2
* D Document Verification with liveness check = 3
</td><td>
Required
</td></tr><tr><td>
linkExpirationDays
</td><td>
Specified the number of calendar days a link is valid for. Default is 7 days.
</td><td>
Optional
</td></tr></tbody></table>
Response Parameters
| Parameter Name |
Description |
| encryptedShortCode |
The unique ID of the ID document verification request. Generally a 4 character code (may be expanded in future). |
| requestLink |
The active URL to be sent to the consumer for verification. |
| isSuccessful |
Provides a status of the request. |
| message |
Provides a description of the success or failure message. |
Sample Cod
{
"phoneNumber": "3055551212",
"idVerificationType": "3",
"linkExpirationDays": "5",
}
curl --location 'https://rest.everyware.com/api/v1/identity-score/identity-verification-request' \
--header 'Authorization: Basic [xxx]' \
--header 'Content-Type: application/json' \
--data-raw ' {
}'
{
"Data": {
"encryptedShortCode": "LFPB",
"requestLink": "https://identity-dev.everyware.com/LFPB"
},
"IsSuccessful": true,
"Message": "A new identity verification request link was created and SMS message sent successfully."
},
|