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

POSThttps://api.public.caf.io/v1/services

Header parameters

Body

application/json

service*string

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

Example: "sanctions"

parameters*object

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

Response

200400401403500

Success

Body

application/json

requestIdstring

messagestring

dataobject

Data returned with sanctions information inside.

Request

JavaScriptCurlPython

const response = await fetch('https://api.public.caf.io/v1/services', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "service": "sanctions",
      "parameters": {
        "name": "text"
      }
    }),
});
const data = await response.json();

Response

200400401403500

{
  "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": {},
          "shareUrl": "https://app.us.complyadvantage.com/public/search/00000",
          "riskLevel": "unknown",
          "sanctionType": "Block"
        }
      ]
    }
  }
}