Verification | ID.me Developer

A verification is the core of an identity attempt. When verifying an identity through multiple products (for example, Document Verification and Telecom Verification), the verification_id ties those requests together.

Watch the verification demo for a walkthrough.

Create new verification

POST /api/v2/verification

Creates a new verification. There are no required parameters for this endpoint.

Parameters

Parameter	Required or Optional	Data Type	Description
`callback_url`	Optional	string	The URL to receive the callback when the verification is created
`metadata`	Optional	application/json	Custom metadata for the verification. Can be any valid JSON value up to 500 characters

Example request

Example

$ curl --location --request POST 'https://services.idmelabs.com/api/v2/verification' \
> --header 'Content-Type: application/json' \
> --data ''

Example response

200 OK

1 {
2 "verification_id": "9b1cef39-46c3-48f2-8dbf-306cf73093bd",
3 "transactions": []
4 }

Verification status

GET /api/v2/verification/:verification_id

Returns a verification and all of its associated transactions.

Mock requests are not valid for this endpoint.

Parameters

Parameter	Required or Optional	Description
`verification_id`	Required	The ID of the verification to retrieve

Example request

Example

$ curl --location 'https://services.idmelabs.com/api/v2/verification/e469c856-7f8e-4aba-8fb4-230bcfea7cf8'

Example response

200 OK

1 {
2   "verification_id": "e469c856-7f8e-4aba-8fb4-230bcfea7cf8",
3   "transactions": [
4     {
5       "transaction_id": "c9298cc5-9917-4b88-850d-991df3864afe",
6       "verification_id": "e469c856-7f8e-4aba-8fb4-230bcfea7cf8",
7       "product": "document.license.verify",
8       "status": {
9         "code": 200,
10         "message": "Transaction successfully completed",
11         "created": "2023-04-04T21:15:52.171Z",
12         "updated": "2023-04-04T21:25:53.301Z"
13       }
14     }
15   ]
16 }

Error responses

403 Forbidden

Example

1 {
2   "errors": [{
3     "code": 3200,
4     "message": "Verification not owned by this account"
5   }]
6 }