API

Connecting to Advanscreen’s Default API.

To perform a screening via the API, your system should send a web request to our server using the following URL format:

https://OURLINK?userName=xxxx@xxx.xx.xx&password=xxx&search=first$middle$last

Parameter Details:

1. `OURLINK` – The specific API endpoint URL provided upon request.
2. `userName` – Your Advanscreen account username.
3. `password`– Your Advanscreen account password.
4. `search` – The full name to be screened, with name parts (first, middle, last) separated by the `$` symbol. The order of name parts is not important. Hyphens within a name part (e.g., *Ben-Yosef*) are treated as part of that name.

Example Response (JSON Format):

The API returns a JSON array, where each entry represents the result of the screening against a specific sanctions list. Each result includes the name of the list and a Boolean value indicating whether a potential match was found.

“`json[
{ “ListName”: “Israel A”, “ReturnValue”: false },
{ “ListName”: “Israel B”, “ReturnValue”: false },
{ “ListName”: “USA”, “ReturnValue”: false },
{ “ListName”: “EU”, “ReturnValue”: true },
{ “ListName”: “UN”, “ReturnValue”: false }
] “`

If any list returns a value of `”true”`, it indicates a potential match. In such cases, users can log in to Advanscreen’s web interface to review the match, add notes, generate PDF reports, and take further actions.

Important Notes:

1. Always perform the screen using the name exactly as it appears on the subject’s official identification document, without phonetic variations, as required by law.
2. All screenings, whether initiated via the API or the web interface, are recorded under your Advanscreen account and can be accessed at any time.
3. The number of returned JSON entries may vary based on the number of sanctions lists available for your account. Plan your integration accordingly.
4. The system does not perform name transliteration or transcription. For example, if a sanctions list is in Hebrew, the input name must also be provided in Hebrew to be matched correctly.

Contact us today:

info@advanscreen.com