LinkinLegalDocs
APIDeveloper console
Reference

Match a subject

Score one person, company or vessel against the sanctions and PEP lists. Returns candidates with a score from 0 to 1 and the reason for each score.

POST/sanctions/match

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/sanctions/match" \  -H "Authorization: Bearer lil_sk_..." \  -H "Content-Type: application/json" \  -d '{    "schema": "Person",    "properties": {      "name": [        "Vladimir Puttin"      ],      "birthDate": [        "1952-10-07"      ],      "citizenship": [        "ru"      ]    },    "threshold": 0.8,    "limit": 5,    "include": [      "sanctions",      "pep"    ]  }'
{  "results": [    {      "id": "Q7747",      "caption": "Vladimir Putin",      "schema": "Person",      "score": 1,      "match": true,      "features": {        "name": 0.9806,        "birthDate": 0.1,        "country": 0.05,        "identifier": null,        "gender": null      },      "datasets": [        "us_ofac_sdn",        "eu_fsf"      ],      "target": true,      "properties": {        "name": [          "Vladimir Putin"        ],        "birthDate": [          "1952-10-07"        ],        "citizenship": [          "ru"        ]      }    }  ]}

Search entities GET

Find sanctioned entities or politically exposed persons by text in the caption, with filters, sorting and paging.

Match many subjects POST

Match 1 to 100 subjects in one call. Each subject has your own id. A subject that is not valid gets its own error and the call still returns 200.