GET
/
verifications
List verifications
curl --request GET \
  --url https://api-sandbox.synctera.com/v0/verifications \
  --header 'Authorization: Bearer <token>'
{
  "next_page_token": "a8937a0d",
  "verifications": [
    {
      "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "creation_time": "2010-05-06T12:23:34.321Z",
      "details": [
        {
          "category": "ADDRESS",
          "description": "Email address is correlated with the individual's name",
          "label": "Email",
          "result": "PASS",
          "score": 0.25,
          "url": "http://example.com/additional-information",
          "vendor_code": "R940"
        }
      ],
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "metadata": {},
      "person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "result": "ACCEPTED",
      "vendor_info": {
        "content_type": "application/json",
        "json": {},
        "vendor": "SOCURE"
      },
      "verification_time": "2023-11-07T05:31:56Z",
      "verification_type": "IDENTITY"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
id
string<uuid>[]

Unique identifier for the resource. Multiple IDs can be provided as a comma-separated list.

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157"

​
verification_type
enum<string>[]

The type of verification run. Multiple values can be provided as a comma-separated list.

​
business_id
string<uuid>[]

Unique identifier for the business. Multiple IDs can be provided as a comma-separated list.

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157"

​
include_history
boolean
default:false

If true, include old (inactive) records as well.

​
page_token
string

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:

"a8937a0d"

​
result
enum<string>[]

The result of the verification that was run on the party. Multiple values can be provided as a comma-separated list.

​
person_id
string<uuid>[]

Unique identifier for the person. Multiple IDs can be provided as a comma-separated list.

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157"

​
limit
integer
default:100

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Required range: x >= 1
Example:

100

Response

200
application/json

List verifications.

The response is of type object.