Sanctions

The sanctions service returns a list of sanctions related to a person provided by the user, if any exist.

Run synchronous Sanctions for Individual

The sanctions service returns a list of sanctions related to a person provided by the user.
Permission required: Services query

post

/services

Header parameters

Authorizationstringrequired

Your access token. See more in the 'Authentication' topic of this section.

Body

servicestring · default: sanctionsrequired

The name of the requested service, for Sanctions need be "sanctions"

Example: sanctions

parametersobjectrequired

The data expected by the service Sanctions

metadataobject

All fields passed to the metadata will be returned in the response, this field is useful to bring an internal identifier of the request for example

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.public.caf.io/v1/services' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "sanctions",
    "parameters": {
      "name": "John Doe",
      "fuzziness": "0.5",
      "birthYear": "1990"
    },
    "metadata": {}
  }'

200

400

401

403

500

200

{
  "requestId": "text",
  "message": "text",
  "data": {
    "service": "sanctions",
    "idempotencyKey": "xxxxxxx",
    "serviceData": {
      "name": "Name",
      "isSanctioned": true,
      "totalMatches": 1,
      "sanctionsList": [
        {
          "matchStatus": "potential_match",
          "matchTypes": [
            "text"
          ],
          "matchTypesDetails": [
            "text"
          ],
          "entityTypess": "person",
          "sources": [
            "text"
          ],
          "sourceNotes": {
            "sanctionRelatedEntities": {}
          },
          "shareUrl": "https://app.us.complyadvantage.com/public/search/00000",
          "riskLevel": "unknown",
          "sanctionType": "Block"
        }
      ]
    },
    "metadata": {}
  }
}

Success