Real-time access to multiple global PEP and Sanction lists, increasing both geographic coverage and quality of service. A robust and effective way to carry out an initial risk. The **PEP and Sanction Checks API** offers a comprehensive and lightweight solution for verifying individuals and companies against global watchlists, ensuring compliance with **Anti-Money Laundering (AML)** and **Counter-Terrorist Financing (CTF)** regulations. This API is available in two modes: 1. **Full PEP and Sanction Checks** 2. **Lite PEP and Sanction Checks** ## 1. Key Features ### Full PEP and Sanction Checks: - Matches entities against PEP, sanction, and adverse media lists. - Supports detailed risk assessments for due diligence. ### Lite PEP and Sanction Checks: - Provides a faster, streamlined version for matching. - Focuses on specific sanctions or lists with customizable inclusion and exclusion options. --- ## 2. Endpoints |**Environment**|**Full API Endpoint**|**Lite API Endpoint**| |---|---|---| |**Test**|`https://test-gateway.zignsec.com/core/api/sessions/company_check/watchlist`|`https://test-gateway.zignsec.com/core/api/sessions/company_check/watchlist_light`| |**Production**|`https://gateway.zignsec.com/core/api/sessions/company_check/watchlist`|`https://gateway.zignsec.com/core/api/sessions/company_check/watchlist_light`| --- ## 3. Request Parameters ### Common Parameters (Full and Lite) | **Field** | **Description** | **Required** | | --------------- | ------------------------------------------------------------ | ------------ | | `name` | Corporate/Organization name, DBA name, or Legal Entity Name. | Yes | | `country_code` | Country code **ISO 3166-1 alpha-2** format Example: de | Yes | | `relay_state` | Optional Custom Parameter | No | | `webhook` | A URL to automatically receive the results via POST. | No | | `scan_settings` | Object that configures scan parameters | | | `gdpr_user_id` | Optional User Identifier | | ### Full API Exclusive Parameters | **Field** | Type | **Description** | **Required** | | ------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------ | | `exact` | boolean | Exact parameter indicates that the exactly matched results or closely matched results should be returned | No | | `max_result_count` | integer | Max result count indicates the maximum number of matches that should be returned. It must be between 1 and 200; defaults to 100 | No | ### Lite API Exclusive Parameters | **Field** | Type | **Description** | **Required** | | --------------- | ---- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | | `included_list` | | Restrict the search to specific sanctions lists. Example: `["UN", "EU"]`. For full list see swagger | No | | `excluded_list` | | Exclude specific sanctions lists. Example: `["OFAC", "SECO"]`. For full list see swagger | No | | `match_rate` | | MatchRate is a percentage from 1-100, which indicates how closely the name being checked matches the name on the matching watchlist profile, with 1% being not close and 100% being very close. If you enter the optional field country and it does not match the Emerald database, the match rate will be reduced by 50%. | No | --- ## 4. Response Parameters |**Field**|**Description**| |---|---| |`id`|Unique session identifier for the request.| |`status`|Current status of the request: `Created`, `Finished`, `Failed`, or `Timeout`.| |`numberOfMatches`|Total number of matches found.| |`matched_entities`|Detailed list of matched entities.| |`errors`|If applicable, contains error details for the request.| ### Matched Entity Details | **Field** | **Description** | | ------------------- | --------------------------------------------------------------------------------------------- | | `unique_id` | Unique identifier of the matched entity. | | `category` | Entity category, such as `SIE` (Special Interest Entity) or `TER` (Terrorism-related Entity). | | `name` | Entity name. | | `primary_location` | Primary location of the entity. | | `decision_detail` | Provides due diligence decisions and risk levels. | --- ## 5. Example Requests and Responses ### Full API Example **Request:** ```http POST https://test-gateway.zignsec.com/core/api/sessions/company_check/watchlist Authorization: Your Subscription Key Content-Type: application/json { "metadata": { "name": "Siemens AG", "country": "Germany", "scan_settings": { "exact": false, "max_result_count": 100 } }, "relay_state": "customID12345", "webhook": "https://example.com/webhook" } ``` **Response:** ```json { "data": { "id": "dfc07fae-8807-4ab1-9e75-5132e405dccc", "result": { "matches": [ { "entity": { "name": "Siemens AG", "category": "SIE", "primary_location": "Germany", "decision_detail": "Low Risk" }, "matchRate": 95 } ], "numberOfMatches": 1 }, "status": "Finished" } } ``` --- ### Lite API Example **Request:** ```http POST https://test-gateway.zignsec.com/core/api/sessions/company_check/watchlist_light Authorization: Bearer YOUR-ACCESS-TOKEN Content-Type: application/json { "metadata": { "name": "Al-Shabaab", "country": "Somalia", "scan_settings": { "included_list": ["UN"], "match_rate": 50 } }, "relay_state": "customID67890", "webhook": "https://example.com/webhook" } ``` **Response:** ```json { "data": { "id": "5f2fbdc1-4c85-4ca4-87ad-a94ac071eca5", "result": { "matches": [ { "entity": { "name": "Al-Shabaab", "category": "SIE", "primary_location": "Somalia", "decision_detail": "High Risk" }, "matchRate": 100 } ], "numberOfMatches": 1 }, "status": "Finished" } } ``` --- ## 6. Swagger Documentation Access detailed API documentation: - **Full API Swagger:** [Full API Swagger Documentation](https://gateway.zignsec.com/#/Watchlist%20-%20Business/postCompanyCheckWatchlist) - **Lite API Swagger:** [Lite API Swagger Documentation](https://gateway.zignsec.com/#/Watchlist%20-%20Business/postCompanyCheckWatchlistLight)