Server Documentation
Last updated
Last updated
Find your account's secret key and API keys in your website manager.
Note:
When you send a request, your phone will get an SMS to start the next process.
If your account is not verified, you have to start the process to verify your account information by Dentity’s system first.
POST
https://api.dentity.com/core/api/v1/verification
This creates a new verification request from a customer’s information.
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
metadata: We recommend passing in the metadata (userId,email,trackId...) as a good way for you to compare the data received correctly with the data on your end.
GET
https://api.dentity.com/core/api/v1/verification/:verificationId/status
This returns the status of a verification request.
PDF file endpoint: Get verification PDF file is not supported for all IDV provider. Please contact us before you start to use it.
GET
https://api.dentity.com/core/api/v1/verification/:verificationId/pdf
This returns the PDF file of a verification. The PDF file can only be obtained within 24 hours from the time of completing the IDV.
Depending on which Verification Agent you are using, there are two options for retrieving images and files from Dentity. Please ask Dentity support which method is applicable for your account before integrating this API.
POST
https://api.dentity.com/core/api/v1/programmatic/credential/bulk
Limit of 50 records in a request.
In this case you will likely need to know when the customer is verified so that you can approve their order. This can be done using the callbackUrl option, which will make a request from our system to yours when the verification status is updated, such as when the verification is verified or failed.
We will send a PUT request to the callback URL with the following data in JSON format.
Webhook type:
verification_status will be sent when the status of verification changes
idvImages are not returned for all IDV providers. So contact us before you start using it.
email_delivery_status will be sent when the email sending status change
Email delivery events include processed
, dropped
, delivered
, deferred
, and bounce
.
sms_delivery_status Dentity will send an update to that URL every time the status changes; Values include accepted
, sending
, sent
, failed
, and delivered
.
The request will also have the “Dentity-Signature” header which should be used to verify that the request came from us. Below is an example in NodeJS:
Note: If you would like to receive a webhook for all requests, contact us to set up an automatic webhook for your account.
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Type | Description |
---|---|
Status | Description |
---|---|
x-api-key*
String
Domain’s API Key
key*
String
Your domain’s API Key.
metadata
Object
Custom variable Id or other information { "id":"sample_15fa31da59f69041641984405622"
}
callbackUrl
String
Partner will get verification status when user start process to verify
phoneNumber*
Object
Holder phone number. Object includes dialCode and phone
{
"dialCode": "+1",
"phone": "2048089972" }
String
Holder email.
dateOfBirth
String
MM/DD/YYYY
name
String
{ "firstName": "String", "lastName": "String" },
address
String
{
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string"
}
smsMessage
String
Custom SMS content. The link is required. E.g: {{siteName}} has requested that you verify your information: {{link}}
verificationId*
String
Unique verification id
x-api-key*
String
Domain’s API Key
verificationId*
String
Unique verification id
confidences
Boolean
Include Confidence Scores in the PDF. It's false by default
x-api-key*
String
Domain’s API Key
verificationIds*
Array
[ "62cd2660176d230010eeb491", "62cd36133fa924001195d809" ]
verification_status
Verification status change
email_delivery_status
Email delivery status change
sms_delivery_status
SMS delivery status change
processed
Message has been received and is ready to be delivered.
dropped
You may see the following drop reasons: Invalid SMTPAPI header, Spam Content (if Spam Checker app is enabled), Unsubscribed Address, Bounced Address, Spam Reporting Address, Invalid, Recipient List over Package Quota
delivered
Message has been successfully delivered to the receiving server.
deferred
Receiving server temporarily rejected the message.
bounce
Receiving server could not or would not accept mail to this recipient permanently. If a recipient has previously unsubscribed from your emails, the message is dropped.
blocked
Receiving server could not or would not accept the message temporarily. If a recipient has previously unsubscribed from your emails, the message is dropped.