Sanctions API (1.0.2)

Download OpenAPI specification:Download

API to sanctionscheck.co

Searches

Creates a search

extended info...

query Parameters

pageSize

integer [ 1 .. 30 ]

Default: 30

The number of entities to return in the response

Request Body schema: application/json

term	string
strategy	string
sourceName	string

Responses

Request samples

Payload

Content type

application/json

{"term": "string",
"strategy": "string",
"sourceName": "string"
}

Response samples

201

Content type

application/json

{"search": {"id": "string",
"accountId": "string",
"certificatePdf": "http://example.com",
"createdAt": "2019-08-24T14:15:22Z",
"resultsCount": 0,
"source": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"title": "string"
},
"strategy": "string",
"term": "string",
"url": "http://example.com",
"userId": "string"
},
"results": [{"id": "string",
"resultData": {"id": "string",
"match": true,
"score": 0,
"schema": "string",
"target": true,
"caption": "string",
"datasets": ["string"
],
"features": {"property1": 0,
"property2": 0
},
"last_seen": "2019-08-24T14:15:22Z",
"referents": ["string"
],
"first_seen": "2019-08-24T14:15:22Z",
"properties": {"property1": ["string"
],
"property2": ["string"
]
}
},
"type": "string",
"url": "http://example.com"
}
],
"nextPageToken": "string"
}

Get a specific search

Retrieves a specific search by its ID.

path Parameters

id

required

string <uuid>

ID of the search to be retrieved.

Responses

Response samples

200

Content type

application/json

{"search": {"id": "string",
"accountId": "string",
"certificatePdf": "http://example.com",
"createdAt": "2019-08-24T14:15:22Z",
"resultsCount": 0,
"source": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"title": "string"
},
"strategy": "string",
"term": "string",
"url": "http://example.com",
"userId": "string"
},
"results": [{"id": "string",
"resultData": {"id": "string",
"match": true,
"score": 0,
"schema": "string",
"target": true,
"caption": "string",
"datasets": ["string"
],
"features": {"property1": 0,
"property2": 0
},
"last_seen": "2019-08-24T14:15:22Z",
"referents": ["string"
],
"first_seen": "2019-08-24T14:15:22Z",
"properties": {"property1": ["string"
],
"property2": ["string"
]
}
},
"type": "string",
"url": "http://example.com"
}
],
"nextPageToken": "string"
}

Sources

Lists all available data sources

Index action listing all the available data sources. Provides access to each source's name field which can be used for specifying a source when performing a search.

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"title": "string"
}
]