v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
KYC/KYB Verifications

Check if an individual is on any watchlists

post/verifications/adhoc

Headers

Idempotency-Keystring
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

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.

Request body

payee_idstring uuid required

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

payer_idstring uuid required

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

Response

successful check

idstring uuid required

Unique ID for this verification result.

matching_watchlistsstring[] required

list of watchlists that the subject of the request matched

result'ACCEPTED' | 'PENDING' | 'PROVISIONAL' | 'REJECTED' | 'REVIEW' | 'UNVERIFIED' | 'VENDOR_ERROR' 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.

Example response

{
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "result": "ACCEPTED",
  "vendor_info": {
    "vendor": "SOCURE"
  }
}