## Overview
The `postCompanyCheckPepGlobalMemberCheck` endpoint is part of the ZignSec Watchlist Business API. This endpoint facilitates screening businesses and their associated members against global PEP (Politically Exposed Persons) watchlists. It provides an essential tool for compliance and risk management, allowing businesses to ensure they meet regulatory requirements.
---
## Endpoint Details
### URL
```
POST https://gateway.zignsec.com/core/api/sessions/company_check/pep_global_member_check
```
### Method
`POST`
### Authentication
API Key authentication is required. Include the API key in the header for each request:
```json
{
"Authorization": "Your Subscription Key"
}
```
---
## Request Parameters
### Headers
| Parameter | Type | Required | Description |
|----------------|--------|----------|----------------------------------|
| `Authorization`| String | Yes | Subscription key for access. |
| `Content-Type` | String | Yes | Set to `application/json`. |
| `Accept` | String | No | Set to `application/json`. |
### Body Parameters (JSON)
| Parameter | Type | Required | Description |
|---------------------------|----------|----------|--------------------------------------------------|
| `metadata` | Object | Yes | Metadata object containing additional details. |
| `metadata.address` | String | No | Address of the company. |
| `metadata.company_name` | String | Yes | Name of the company to be checked. |
| `metadata.close_match_rate_threshold`| Integer | No | Threshold for close match rates (1-100). |
| `metadata.include_web_search`| String| No | Set to `Yes` or `No` to include web searches. |
| `metadata.match_type` | String | No | Type of match (`Exact` or `Close`). |
| `metadata.registration_number`| String| No | Registration number of the company. |
| `metadata.update_monitoring_list`| String| No | Set to `Yes` or `No` to update monitoring list. |
| `metadata.whitelist` | String | No | Action for whitelist (`Ignore`, etc.). |
| `relay_state` | String | No | State to relay to after the process. |
| `webhook` | String | No | URL for webhook to receive notifications. |
---
## Example Request
### Request Body
```json
{
"metadata": {
"address": "",
"close_match_rate_threshold": 80,
"company_name": "Siemens",
"include_web_search": "No",
"match_type": "Close",
"registration_number": "",
"update_monitoring_list": "No",
"whitelist": "Ignore"
},
"relay_state": "Tulasi_Test",
"webhook": "https://webhook.site/zignsec"
}
```
### cURL Example
```bash
curl --location 'https://gateway.zignsec.com/core/api/sessions/company_check/pep_global_member_check' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Your Subscription Key' \
--data '{
"metadata": {
"address": "",
"close_match_rate_threshold": 80,
"company_name": "Siemens",
"include_web_search": "No",
"match_type": "Close",
"registration_number": "",
"update_monitoring_list": "No",
"whitelist": "Ignore"
},
"relay_state": "Tulasi_Test",
"webhook": "https://webhook.site/zignsec"
}'
```
---
## Response
### Successful Response
#### Status Code: `200 OK`
```json
{
"data": {
"id": "577a1a1b-9929-43c4-b3de-6ad8dc4b71b7",
"result": {
"dataSources": "Acuris",
"matchedEntities": [
{
"category": "SIE",
"decisionDetail": {
"assessedRisk": "Unallocated",
"comment": null,
"matchDecision": "NotReviewed",
"text": "Not Reviewed"
},
"matchRate": 100,
"matchedFields": "FullPrimaryName",
"name": "Siemens (Taiwan Branch)",
"primaryLocation": "Taiwan",
"resultEntity": {
"categories": "Special Interest Entity (SIE) - Regulatory Enforcement, Special Interest Entity (SIE) - Reputational Risk",
"category": "SIE",
"countries": [],
"dataSource": "Acuris",
"descriptions": [
{
"description1": "Special Interest Entity (SIE)",
"description2": "Regulatory Enforcement",
"description3": ""
},
{
"description1": "Special Interest Entity (SIE)",
"description2": "Reputational Risk",
"description3": ""
}
],
"enterDate": null,
"furtherInformation": null,
"generalInfo": [],
"identifiers": [],
"lastReviewed": "2022-05-16",
"linkedCompanies": [],
"linkedIndividuals": [],
"locations": [
{
"address": "",
"city": null,
"country": "Taiwan",
"countryCode": "TW",
"type": "Operating"
}
],
"nameDetails": [
{
"entityName": "Siemens",
"nameType": "Name Spelling Variation"
}
],
"officialLists": [],
"oldProfile": false,
"originalScriptNames": [],
"primaryLocation": "Taiwan",
"primaryName": "Siemens (Taiwan Branch)",
"profileOfInterests": [],
"sources": [
{
"categories": "Corporate/Business, Regulatory Enforcement List",
"dates_Urls": {
"2013-12-20": ""
},
"details": [
{
"assetUrl": null,
"captureDate": "2013-12-20",
"categories": "Corporate/Business, Regulatory Enforcement List",
"credibility": null,
"keywords": null,
"language": null,
"originalUrl": "http://www.sec.gov/servlet/Satellite/News/PressRelease/Detail/PressRelease/1365171485830",
"publicationDate": null,
"summary": "The source mentions corporate interests of the subject, business description, or other corporate identifiers. Please refer to the Businesses and Details sections of the profile.",
"title": null
}
],
"url": "http://www.sec.gov/servlet/Satellite/News/PressRelease/Detail/PressRelease/1365171485830"
},
{
"categories": "Reputational Risk Exposure",
"dates_Urls": {
"2011-01-21": ""
},
"details": [
{
"assetUrl": null,
"captureDate": "2011-01-21",
"categories": "Reputational Risk Exposure",
"credibility": null,
"keywords": null,
"language": null,
"originalUrl": "http://www.chinapost.com.tw/print/288477.htm",
"publicationDate": null,
"summary": "TAIPEI --Taiwan has punished nine high-tech companies, including the local unit of Siemens, for violating regulations limiting staff working hours, an official and the media said Thursday. We have instructed our staff not to violate relevant regulations,\" said Ray Jui, corporate communications director of Siemens in Taipei.",
"title": "Taiwan punishes Siemens, others for overworking staff"
}
],
"url": "http://www.chinapost.com.tw/print/288477.htm"
}
],
"uniqueId": 2734176,
"xmlFurtherInformation": null
},
"resultId": 4545763,
"uniqueId": 2734176
}
],
"matchedNumber": 1,
"metadata": {
"message": "1 match found for Sanctions and Adverse Media. "
},
"scanId": 7438420
}
}
}
```
### Error Responses
#### Status Code: `400 Bad Request`
```json
{
"status": "Error",
"message": "Invalid input parameters."
}
```
#### Status Code: `401 Unauthorized`
```json
{
"status": "Error",
"message": "Invalid or missing API key."
}
```
#### Status Code: `500 Internal Server Error`
```json
{
"status": "Error",
"message": "An unexpected error occurred."
}
```
---
## Notes
- The `metadata` object is essential for configuring the company check parameters.
- Ensure the subscription key is valid and has the necessary permissions.
- The API has rate-limiting; excessive requests may result in temporary blocking.
---
## Contact Support
For further assistance, contact ZignSec support at [
[email protected]](mailto:
[email protected]).