Skip to main content
POST
/
customers
/
{customer_id}
/
verify
Verify a customer's identity
curl --request POST \
  --url https://api-sandbox.synctera.com/v0/customers/{customer_id}/verify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_consent": true,
  "customer_ip_address": "66.152.213.183"
}
'
{
  "kyc_status": "ACCEPTED",
  "verifications": [
    {
      "result": "ACCEPTED",
      "verification_time": "2023-11-07T05:31:56Z",
      "verification_type": "kyc",
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "issues": [
        "R186: Global Watchlist sources selected are correlated with the input identifiers"
      ],
      "raw_response": {
        "provider": "SOCURE",
        "raw_data": "{}"
      },
      "vendor_info": {
        "content_type": "text/xml",
        "vendor": "IDOLOGY",
        "xml": "<string>",
        "details": [
          {
            "code": "R186",
            "description": "Global Watchlist sources selected are correlated with the input identifiers"
          }
        ]
      }
    }
  ],
  "next_page_token": "a8937a0d"
}

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"

Path Parameters

​
customer_id
string<uuid>
required

The customer's unique identifier

Example:

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

Body

application/json

Customer verification request.

​
customer_consent
boolean
required

Whether this customer has consented to a KYC check.

​
customer_ip_address
string

IP address of the customer being verified.

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"

​
verification_type
enum<string>[]

List of possible checks to run on a customer. This is a legacy field that is now ignored.

The type of check run on the customer.

Available options:
addressrisk,
alertlist,
decision,
documentverification,
emailrisk,
fraud,
kyc,
phonerisk,
social,
synthetic,
watchlistplus,
watchlistpremier,
watchliststandard

Response

Customer verification result.

​
kyc_status
enum<string>
required

Customer's KYC status

Available options:
ACCEPTED,
PENDING,
PROVIDER_FAILURE,
PROVISIONAL,
REJECTED,
REVIEW,
UNVERIFIED
​
verifications
CustomerVerificationResult · 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"