Documentation Powered by ReDoc

Sanctions API (1.0.2)

Download OpenAPI specification:Download

API to sanctionscheck.co

Authentication

bearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer

Entities

Represents an entity

extended info...

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

ID of the entity to be retrieved.

Responses

Response samples

Content type
application/json
{
  • "entity":
    {
    }
}

Searches

Creates a search

extended info...

Authorizations:
bearerAuth
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
Default: "partial"
Enum: "partial" "exact"

Responses

Request samples

Content type
application/json
{
  • "term": "string",
  • "strategy": "partial"
}

Response samples

Content type
application/json
{
  • "search":
    {
    },
  • "results":
    [
    ],
  • "nextPageToken": "string"
}

Represents a search

extended info...

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid> >= 1

ID of the search to be retrieved.

query Parameters
nextPageToken
string

Token used to fetch the next page of search results (provided in a previous response)

pageSize
integer [ 1 .. 30 ]
Default: 30

The number of entities to return in the response

Responses

Response samples

Content type
application/json
{
  • "search":
    {
    },
  • "results":
    [
    ],
  • "nextPageToken": "string"
}