POST
/
verifications
/
adhoc
Check if an individual is on any watchlists
curl --request POST \
  --url https://api-sandbox.synctera.com/v0/verifications/adhoc \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "payee_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
{
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "matching_watchlists": [
    "US_OFAC"
  ],
  "result": "ACCEPTED",
  "vendor_info": {
    "content_type": "application/json",
    "json": {},
    "vendor": "SOCURE"
  }
}

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

Basic identifying information about the person being verified.

​
payee_id
string<uuid>
required

Synctera party (non-customer) who is receiving money from a customer (the payer)

​
payer_id
string<uuid>
required

Synctera customer who is sending money to a non-customer (the payee)

Response

successful check

​
id
string<uuid>
required

Unique ID for this verification result.

Example:

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

​
matching_watchlists
enum<string>[]
required

list of watchlists that the subject of the request matched

​
result
enum<string>
required

The determination of this verification. One of the following:

  • UNVERIFIED – record representing the absence of a verification.
  • 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.
  • VENDOR_ERROR – verification did not successfully run due to an unexpected error or failure.
  • REJECTED – the customer was rejected and should not be allowed to take certain actions e.g., open an account.
Available options:
ACCEPTED,
PENDING,
PROVISIONAL,
REJECTED,
REVIEW,
UNVERIFIED,
VENDOR_ERROR
Example:

"ACCEPTED"

​
vendor_info
object

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