POST
/
verifications
/
verify
Verify a customer's identity
curl --request POST \
  --url https://api-sandbox.synctera.com/v0/verifications/verify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "customer_consent": true,
  "customer_ip_address": "235.2.7.2",
  "person_id": "1bb26bcb-0e1b-4060-972d-80891332aae2"
}'
{
  "next_page_token": "a8937a0d",
  "verification_status": "ACCEPTED",
  "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.

Headers

​
Idempotency-Key
string

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Body

application/json

Response

201
application/json

Created identity request.

The response is of type object.