Documentation v2.
servicestack icon Metadata swagger icon Swagger UI

Important information for XML API usage

If you consume the API via XML the alphabetical order of elements in the XML data is important. The order of elements must be maintained as alphabetical. If elements are sent out of order there is the possibility of data loss. If you use the examples as shown in the metadata you will have the correct alphabetical order. E.g. for AddSearch see here.

Recent Changes

Release - March 2025

Changed

Added

Release - February 2025

Added

Release - January 2025

Added

Release - October 2024

Added

  • Introduced a set of endpoints for sourcing Client documents via ValidateMe.
  • Documentation for the Client API Flow covering ValidateMe and ValidID.
  • Added a ValidID template endpoint to assist in creating ValidIDs from Clients.
  • Included missing endpoints to enabled full CRUD functionality for SubUsers.

Changed

  • Streamlined the ability to Add and Retrieve Searches, ValidIDs, CompanyLookups, and PEPs within the SubUser context.

API Endpoints

The endpoints of our API can be accessed using JSON, XML, or SOAP using POST requests.

  • JSON: POST https://api.sanctionssearch.com/v2/json/reply/{APIMethodName}
  • XML: POST https://api.sanctionssearch.com/v2/xml/reply/{APIMethodName}
  • SOAP 1.1: POST https://api.sanctionssearch.com/v2/soap11
  • SOAP 1.2: POST https://api.sanctionssearch.com/v2/soap12

The JSON and XML endpoints contain the name of the API method you are accessing, such as "AddSearch" or "GetSearch", i.e.

  • JSON: POST https://api.sanctionssearch.com/v2/json/reply/AddSearch
  • XML: POST https://api.sanctionssearch.com/v2/xml/reply/AddSearch

Please ensure that the body of the POST request contains the correct data payload in the correct format, please see the metadata for more information regarding the correct format, and see the documentation below for more information about the meaning of each of the API method parameters.

URL formats and HTTP Verbs will follow these examples unless specified otherwise.

If you are using the XML endpoint please note the message below.

API Methods

Sanctions Searches

PEP Searches

ValidId Searches

CompanyLookup Searches

Bulk Searches

Account

Clients (ValidateMe)

DBS Searches

Other Information

Clients (ValidateMe)

API Objects

Base objects

Sanctions Searches

PEP Searches

CompanyLookup

Bulk Searches

ValidID

Account

Clients

DBS Searches

ValidID (Deprecated Features)