Skip to main content
POST
/
verifications
/
verify
Verify a customer's identity
curl --request POST \
  --url https://api.synctera.com/v2/verifications/verify \
  --header 'Content-Type: application/json' \
  --data '{
  "customer_consent": true,
  "customer_ip_address": "235.2.7.2",
  "person_id": "1bb26bcb-0e1b-4060-972d-80891332aae2"
}'
{
  "verification_status": "ACCEPTED",
  "verifications": [
    {
      "business_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "creation_time": "2010-05-06T12:23:34.321Z",
      "details": [
        {
          "category": "WATCHLIST",
          "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": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "result": "ACCEPTED",
      "vendor_info": {
        "content_type": "application/json",
        "json": {},
        "vendor": "SOCURE"
      },
      "verification_time": "2023-11-07T05:31:56Z",
      "verification_type": "IDENTITY"
    }
  ],
  "next_page_token": "a8937a0d"
}

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
​
customer_consent
boolean
required

Whether this customer has consented to be verified.

​
business_id
string<uuid>

Unique ID for the business. Exactly one of business_id or person_id must be set.

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

​
customer_ip_address
string

The customer's IP address.

Example:

"140.151.183.216"

​
document_id
string

The ID of the uploaded government-issued identification document provided by the Socure SDK.

Example:

"1ab2c3de-fg45-6789-a01b-23c45678defg"

​
person_id
string<uuid>

Unique ID for the person. Exactly one of person_id or business_id must be set.

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

Response

Created identity request.

​
verification_status
enum<string>
required

The result of a KYC/KYB verification. One of the following:

  • UNVERIFIED – verification has not been completed for this customer.
  • PENDING – verification is in progress for this customer.
  • PROVISIONAL – partially verified or verified with restrictions.
  • ACCEPTED – the customer has been verified.
  • REVIEW – verification has run and issues have been identified and require review.
  • REJECTED – the customer was rejected and should not be allowed to take certain actions e.g., open an account.
Available options:
UNVERIFIED,
PENDING,
PROVISIONAL,
ACCEPTED,
REVIEW,
REJECTED
Example:

"ACCEPTED"

​
verifications
object[]
required

Array of verification results.

​
next_page_token
string

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example:

"a8937a0d"