POST
/
customers
/
{customer_id}
/
verifications
Create a customer verification result
curl --request POST \
  --url https://api-sandbox.synctera.com/v0/customers/{customer_id}/verifications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "raw_response": {
    "provider": "SOCURE",
    "raw_data": "{}"
  },
  "result": "ACCEPTED",
  "vendor_info": {
    "content_type": "text/xml",
    "vendor": "IDOLOGY",
    "xml": "<string>"
  },
  "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": "{}"
  },
  "result": "ACCEPTED",
  "vendor_info": {
    "content_type": "text/xml",
    "details": [
      {
        "code": "R186",
        "description": "Global Watchlist sources selected are correlated with the input identifiers"
      }
    ],
    "vendor": "IDOLOGY",
    "xml": "<string>"
  },
  "verification_time": "2023-11-07T05:31:56Z",
  "verification_type": "kyc"
}

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 result to create.

Verification result

​
result
enum<string>
required

The determination of this verification.

Available options:
ACCEPTED,
PROVIDER_FAILURE,
PROVISIONAL,
REJECTED,
REVIEW
Example:

"ACCEPTED"

​
verification_time
string<date-time>
required

The date and time the verification was completed.

​
verification_type
enum<string>
required

The type of check run on the customer.

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

"kyc"

​
raw_response
object
deprecated
​
vendor_info
object

The information provided to Synctera from the vendor. Interpretation of this object is up to the client.

Response

Created customer verification result.

Verification result

​
result
enum<string>
required

The determination of this verification.

Available options:
ACCEPTED,
PROVIDER_FAILURE,
PROVISIONAL,
REJECTED,
REVIEW
Example:

"ACCEPTED"

​
verification_time
string<date-time>
required

The date and time the verification was completed.

​
verification_type
enum<string>
required

The type of check run on the customer.

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

"kyc"

​
id
string<uuid>

Unique ID for this verification result.

Example:

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

​
issues
string[]
deprecated

List of potential problems found. These are subject to change.

​
raw_response
object
deprecated
​
vendor_info
object

The information provided to Synctera from the vendor. Interpretation of this object is up to the client.