Verifications

The verification object
Attribute
Type
Description
id
uuid
The unique identifier for the verification.
type
string
The type of verification.
sms
drivers_license
passport
status
string
The status of verification.
pending
approved
rejected
cancelled
failed
attempts
integer
The number of verification attemps. Initial value is 1. The maximum number of attempts depends on the verification type and processor.
error_code
string
The error key, in case of an error. The value depends on the verification type and processor.
error_message
string
The error message, in case of an error. The value depends on the verification type and processor.
expires_at
time
The time when the verification expires.
Example
{
  "id": "f346ced3-f80c-45d9-a9f5-a2b0288cb126",
  "type": "sms",
  "status": "pending",
  "attempts": 1,
  "error_code": "",
  "error_message": "",
  "expires_at": "2017-04-19T14:35:09.308904Z"
}
Single-step verification
Single step verification is when the user provides data of a specific type, such as passport or driver's liences information, and the provider processes it afterwards.
Request
Response
Request
POST /v1/verifications
Attribute
Type
Description
type
string
The type of verification.required
drivers_license
passport
data
string
The data which the verification process needs for processing, e.g. passport ID. required
event
string
The name of the verification event, which describes the purpose of the verification. This value can be passed along to custom or 3rd party processors. required
Example
{
  "type": "passport",
  "data": "01234567890123456789",
  "event": "user_kyc"
}
Response
201 Created
Returns a verification object.
Two-step verification
Two-step verification is used when the user initiates the verification process and then provides the required data. For example, request an SMS code for a specific phone number and then provide the code which was sent via SMS.
Step 1– Request data
Request
Response
Request
POST /v1/verifications
Attribute
Type
Description
type
string
The type of verification.required
call
email
sms
recipient
string
The recipient of the verification code, e.g. phone number. required
event
string
The name of the verification event, which describes the purpose of the verification. This value can be passed along to custom or 3rd party processors. required
{
  "type": "sms",
  "recipient": "+44 123 1234 1234",
  "event": "add_new_device"
}
Response
201 Created
Returns a verification object.
Step 2 – Provide requested data
Request
Response
Request
POST /v1/verifications/{id}/data
Attribute
Type
Description
data
string
The data which the verification process needs for processing, e.g. code sent by SMS. required
{
  "data": "123456"
}
Response
200 OK
Returns a verification object.
Get a verification object
Get a single verification object by ID.
Request
Response
Request
GET /v1/verifications/{id}
Response
200 OK
Returns a verification object.

Users

REST Merchant API

Last updated 9 months ago

Attribute	Type	Description
id	uuid	The unique identifier for the verification.
type	string	The type of verification. `sms` `drivers_license` `passport`
status	string	The status of verification. `pending` `approved` `rejected` `cancelled` `failed`
attempts	integer	The number of verification attemps. Initial value is 1. The maximum number of attempts depends on the verification type and processor.
error_code	string	The error key, in case of an error. The value depends on the verification type and processor.
error_message	string	The error message, in case of an error. The value depends on the verification type and processor.
expires_at	time	The time when the verification expires.