Sanctions
The sanctions service returns a list of sanctions related to a person provided by the user, if any exist.
The sanctions service returns a list of sanctions related to a person provided by the user.
Permission required: Services query
Header parameters
AuthorizationstringRequired
Your access token. See more in the 'Authentication' topic of this section.
Body
servicestringRequiredDefault:
The name of the requested service, for Sanctions need be "sanctions"
sanctions
Example: sanctions
metadataobjectOptional
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
200
Success
application/json
400
Invalid provided body
application/json
401
Invalid token
application/json
403
The token does not have permission to access this resource
application/json
500
Internal server error
application/json
post
POST /v1/services HTTP/1.1
Host: api.public.caf.io
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 107
{
"service": "sanctions",
"parameters": {
"name": "John Doe",
"fuzziness": "0.5",
"birthYear": "1990"
},
"metadata": {}
}
{
"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": {}
}
}
Last updated