> ## Documentation Index > Fetch the complete documentation index at: https://devdocs.veriff.com/llms.txt > Use this file to discover all available pages before exploring further. # Watchlist-screening results > ### Returns PEP (Politically Exposed Person) and Sanctions screening results for a verification session #### When to use this endpoint - Use this endpoint to retrieve comprehensive PEP and Sanctions screening result, including match details, confidence scores and source database information after a verification session has been completed. - Common use cases include: - Accessing screening results for compliance and AML (Anti-Money Laundering) purposes - Investigating potential PEP or sanctions matches flagged during verification - Obtaining provider-specific match data including match confidence and source information - Conducting enhanced due diligence based on screening results - Retrieving ongoing monitoring status for the session #### Response data - The response includes screening results such as match status, search parameters used, and detailed hit information when matches are found. - Key data returned: - `matchStatus`: indicates if matches were found (`possible_match` or `no_match`) - `monitorStatus`: shows if ongoing monitoring is enabled or disabled for this session - `searchTerm`: shows the exact search parameters used (name, year, lists checked, match threshold) - `totalHits`: number of records matched in PEP and Sanctions databases - `hits`: array of detailed match data including matched names, countries, dates, match types, and related listings - If no matches are found in PEP or Sanctions databases, the `hits` array will be empty and `matchStatus` will be `no_match`. - For `matchTypes`, see the [data provider's documentation](https://docs.complyadvantage.com/) for more detailed info. #### About matchStatus field - The `matchStatus` field is the primary outcome indicator of the AML/PEP screening itself. It directly answers the compliance question "Is this person flagged on any watchlist?" - The field has two possible values: - `possible_match`: the person was found in one or more listings/databases. The `data.hits` array is populated with data about the person. - `no_match`: the person was not found. The `data.hits` array is empty. - This is independent from the session decision (`approved`/`declined`), which is driven by IDV checks. - The confidence in the `matchStatus` is higher when combined with IDV, because the screening data was extracted from a verified document. In standalone mode, the accuracy of the screening depends on the quality of the data you input. - If you require more data, you can use the relevant `sessionId` and query the [GET sessions/sessionId/person](https://devdocs.veriff.com/apidocs/v1sessionsidperson-1) endpoint to find more detailed info about the match. Look for data in the `person.pepSanctionMatches` array. #### Possible session outcomes - **Session approved + matchStatus: no_match** - This is the ideal outcome. The end-user's identity was verified successfully and they were not found on any PEP/Sanctions/Adverse Media lists. You can proceed with onboarding, no further AML action needed. - **Session approved + matchStatus: possible_match** - The end-user's identity is verified (the document and selfie are genuine), but they were found on one or more watchlists. Veriff only flags potential matches, you retain decisioning responsibility. Therefore, you need to perform manual review: - Review the `hits` array to examine the matched listings (source names, URLs, match types, etc.). - Determine whether the hit is a true match or a false positive (e.g., common name coincidence). - Apply your own risk-based decision depending on your regulation and requirements (decline the end-user, apply enhanced due diligence, or escalate). #### Screening availability - **Screening timing:** Results are typically available within seconds to minutes after session completion, depending on: - Session submission and processing time - Provider database response times - Complexity of search parameters - **Response status codes:** - `200` = Screening results ready (either matches found or no matches) - `202` = Screening still in progress, results not yet available - `402` = PEP & Sanctions screening is not enabled for your integration - If you receive a `202` response, wait a few seconds and retry the request. #### Implementation notes - This endpoint requires session-level [HMAC signature](https://devdocs.veriff.com/docs/hmac-authentication-and-endpoint-security#public-api-v1) authentication - PEP & Sanctions screening must be enabled for your integration to receive results - The `checkType` field indicates if this is the `initial_result` or an `updated_result` from ongoing monitoring - Handle both `possible_match` and `no_match` scenarios in your implementation - Always ensure that you use the correct API URL to send requests. See the [API URL section](https://devdocs.veriff.com/apidocs/veriff-public-api-guides#api-url) for more info - The order of parameters in the real API response can differ from the order you see in this documentation. This is expected and part of the [Backwards compatible changes](https://devdocs.veriff.com/apidocs/veriff-public-api-guides#backwards-compatible-changes) requirements ## OpenAPI ````json GET /v1/sessions/{id}/watchlist-screening { "openapi": "3.0.0", "info": { "title": "Veriff Public API", "version": "1.0.0" }, "servers": [ { "url": "https://example-base-url" } ], "paths": { "/v1/sessions/{id}/watchlist-screening": { "get": { "operationId": "retrieveWatchlistScreeningData", "summary": "Watchlist-screening results", "description": "### Returns PEP (Politically Exposed Person) and Sanctions screening results for a verification session\n\n#### When to use this endpoint\n\n- Use this endpoint to retrieve comprehensive PEP and Sanctions screening result, including match details, \n confidence scores and source database information after a verification session has been completed.\n\n- Common use cases include:\n - Accessing screening results for compliance and AML (Anti-Money Laundering) purposes\n - Investigating potential PEP or sanctions matches flagged during verification\n - Obtaining provider-specific match data including match confidence and source information\n - Conducting enhanced due diligence based on screening results\n - Retrieving ongoing monitoring status for the session\n\n#### Response data\n\n- The response includes screening results such as match status, search parameters used, \n and detailed hit information when matches are found. \n \n- Key data returned:\n - `matchStatus`: indicates if matches were found (`possible_match` or `no_match`)\n - `monitorStatus`: shows if ongoing monitoring is enabled or disabled for this session\n - `searchTerm`: shows the exact search parameters used (name, year, lists checked, match threshold)\n - `totalHits`: number of records matched in PEP and Sanctions databases\n - `hits`: array of detailed match data including matched names, countries, dates, match types, and related listings\n\n- If no matches are found in PEP or Sanctions databases, the `hits` array will be empty and `matchStatus` will be `no_match`.\n\n- For `matchTypes`, see the [data provider's documentation](https://docs.complyadvantage.com/) for more detailed info.\n\n#### About matchStatus field\n\n- The `matchStatus` field is the primary outcome indicator of the AML/PEP screening itself. It directly \n answers the compliance question \"Is this person flagged on any watchlist?\"\n- The field has two possible values:\n - `possible_match`: the person was found in one or more listings/databases. The `data.hits` array is \n populated with data about the person.\n - `no_match`: the person was not found. The `data.hits` array is empty.\n\n- This is independent from the session decision (`approved`/`declined`), which is driven by IDV checks.\n\n- The confidence in the `matchStatus` is higher when combined with IDV, because the screening data was \n extracted from a verified document. In standalone mode, the accuracy of the screening depends on \n the quality of the data you input.\n\n- If you require more data, you can use the relevant `sessionId` and query the \n [GET sessions/sessionId/person](https://devdocs.veriff.com/apidocs/v1sessionsidperson-1) endpoint to find more \n detailed info about the match. Look for data in the `person.pepSanctionMatches` array.\n\n#### Possible session outcomes\n\n- **Session approved + matchStatus: no_match**\n - This is the ideal outcome. The end-user's identity was verified successfully and they were not found on any PEP/Sanctions/Adverse Media lists. You can proceed with onboarding, no further AML action needed.\n\n- **Session approved + matchStatus: possible_match**\n - The end-user's identity is verified (the document and selfie are genuine), but they were found on one or more watchlists. \n Veriff only flags potential matches, you retain decisioning responsibility. Therefore, you need to perform manual review:\n - Review the `hits` array to examine the matched listings (source names, URLs, match types, etc.).\n - Determine whether the hit is a true match or a false positive (e.g., common name coincidence).\n - Apply your own risk-based decision depending on your regulation and requirements (decline the end-user, apply enhanced due diligence, or escalate).\n\n#### Screening availability\n\n- **Screening timing:** Results are typically available within seconds to minutes after session completion, depending on:\n - Session submission and processing time\n - Provider database response times\n - Complexity of search parameters\n\n- **Response status codes:**\n - `200` = Screening results ready (either matches found or no matches)\n - `202` = Screening still in progress, results not yet available\n - `402` = PEP & Sanctions screening is not enabled for your integration \n - If you receive a `202` response, wait a few seconds and retry the request.\n\n#### Implementation notes\n\n- This endpoint requires session-level [HMAC signature](https://devdocs.veriff.com/docs/hmac-authentication-and-endpoint-security#public-api-v1) authentication\n- PEP & Sanctions screening must be enabled for your integration to receive results\n- The `checkType` field indicates if this is the `initial_result` or an `updated_result` from ongoing monitoring\n- Handle both `possible_match` and `no_match` scenarios in your implementation\n- Always ensure that you use the correct API URL to send requests. See the [API URL section](https://devdocs.veriff.com/apidocs/veriff-public-api-guides#api-url) for more info\n- The order of parameters in the real API response can differ from the order you see in this documentation. This is expected and part of the [Backwards compatible changes](https://devdocs.veriff.com/apidocs/veriff-public-api-guides#backwards-compatible-changes) requirements\n", "tags": [ "Session results" ], "parameters": [ { "name": "id", "in": "path", "required": "true", "description": "Verification session ID.", "schema": { "type": "string", "format": "uuid" }, "example": "f04bdb47-d3be-4b28-b028-a652feb060b5" }, { "name": "X-AUTH-CLIENT", "in": "header", "required": "true", "description": "Your integration's API key (occasionally referred to as the \"Token\", \"API public key\" or \"Publishable key\"). Required for all API requests.\n\nYou can find your API key in the Veriff Customer Portal > Settings > API keys.\n", "schema": { "type": "string" }, "example": "your_api_key" }, { "name": "X-HMAC-SIGNATURE", "in": "header", "required": "true", "description": "Session ID signed with the shared secret key. Required to authenticate the request sender.", "schema": { "type": "string" }, "example": "a1b2c3d4e5f67890abcdef1234567890abcdef1234567890abcdef1234567890" } ], "responses": { "200": { "description": "Watchlist screening data", "headers": { "Content-Type": { "description": "Response content type.", "schema": { "type": "string", "example": "application/json" } }, "X-AUTH-CLIENT": { "description": "API key echoed back in response.", "schema": { "type": "string" } }, "X-HMAC-SIGNATURE": { "description": "Response body signed with the shared secret key. Required to authenticate the response sender.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WatchlistResponse" }, "examples": { "match_found": { "description": "Example showing a possible match in PEP databases with detailed hit information", "value": { "status": "success", "data": { "attemptId": "aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7", "sessionId": "f04bdb47-d3be-4b28-b028-a652feb060b5", "vendorData": "customer_ref_12345", "endUserId": "c1de400b-1877-4284-8494-071d37916197", "checkType": "initial_result", "matchStatus": "possible_match", "monitorStatus": "enabled", "searchTerm": { "name": "GADDAFI", "year": "1942", "lists": [ "SANCTIONS", "PEP_CLASS_1", "PEP_CLASS_2" ], "countries": [ "US", "GB", "FR" ], "exactMatch": "false", "matchThreshold": "80", "excludeDeceased": "true" }, "totalHits": "1", "createdAt": "2021-07-05T13:23:59.851Z", "hits": [ { "matchedName": "Mouammar Mohammed Abu Minyar Kadhafi", "countries": [ "Libya", "US" ], "dateOfBirth": "1942", "dateOfDeath": "2011", "matchTypes": [ "matching_name" ], "aka": [ "Moammar Qaddafi", "Muammar Gaddafi" ], "associates": [ "Saif al-Islam Gaddafi" ], "listingsRelatedToMatch": { "warnings": [], "sanctions": [ { "sourceName": "UN Security Council Sanctions", "sourceUrl": "https://www.un.org/securitycouncil/sanctions", "date": "2011-02-26" } ], "fitnessProbity": [], "pep": [ { "sourceName": "ComplyAdvantage PEP data", "sourceUrl": null, "date": null } ], "adverseMedia": [ { "sourceName": "International Media Coverage", "snippet": "Sang Tan Judges in the High Court in London have ruled that Saleh Ibrahim Mabrouk, a former aide of Libyan leader Colonel Muammar Gaddafi, was partly to blame for the murder of PC Yvonne Fletcher. The gunman", "sourceUrl": null, "date": "2011-03-15" } ] } } ] } } }, "no_match": { "description": "Example showing screening completed with no matches in any databases", "value": { "status": "success", "data": { "attemptId": "aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7", "sessionId": "f04bdb47-d3be-4b28-b028-a652feb060b5", "vendorData": "customer_ref_12345", "endUserId": "c1de400b-1877-4284-8494-071d37916197", "checkType": "initial_result", "matchStatus": "no_match", "monitorStatus": "enabled", "searchTerm": { "name": "JOHN SMITH", "year": "1985", "lists": [ "SANCTIONS", "PEP_CLASS_1" ], "countries": [ "US" ], "exactMatch": "false", "matchThreshold": "80", "excludeDeceased": "true" }, "totalHits": "0", "createdAt": "2021-07-05T13:23:59.851Z", "hits": [] } } }, "monitoring_update": { "description": "Example showing an updated result from ongoing monitoring after initial screening", "value": { "status": "success", "data": { "attemptId": "aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7", "sessionId": "f04bdb47-d3be-4b28-b028-a652feb060b5", "vendorData": "customer_ref_12345", "endUserId": "c1de400b-1877-4284-8494-071d37916197", "checkType": "updated_result", "matchStatus": "possible_match", "monitorStatus": "enabled", "searchTerm": { "name": "MARIA SANTOS", "year": "1978", "lists": [ "SANCTIONS", "PEP_CLASS_1", "PEP_CLASS_2" ], "countries": [ "BR", "US" ], "exactMatch": "false", "matchThreshold": "80", "excludeDeceased": "false" }, "totalHits": "1", "createdAt": "2021-07-15T08:45:22.123Z", "hits": [ { "matchedName": "Maria Santos Silva", "countries": [ "Brazil" ], "dateOfBirth": "1978", "dateOfDeath": null, "matchTypes": [ "matching_name", "year_of_birth" ], "aka": [ "Maria S. Silva" ], "associates": [], "listingsRelatedToMatch": { "warnings": [], "sanctions": [], "fitnessProbity": [], "pep": [ { "sourceName": "Brazil Government Officials Database", "sourceUrl": null, "date": "2021-07-14" } ], "adverseMedia": [ { "sourceName": "Local News Reports", "snippet": "Sang Tan Judges in the High Court in London have ruled that Saleh Ibrahim Mabrouk, a former aide of Libyan leader Colonel Muammar Gaddafi, was partly to blame for the murder of PC Yvonne Fletcher. The gunman", "sourceUrl": null, "date": "2021-07-10" } ] } } ] } } } } } } }, "202": { "description": "Watchlist screening is in progress", "headers": { "Content-Type": { "description": "Response content type.", "schema": { "type": "string", "example": "application/json" } }, "X-AUTH-CLIENT": { "description": "API key echoed back in response.", "schema": { "type": "string" } }, "X-HMAC-SIGNATURE": { "description": "Response body signed with the shared secret key. Required to authenticate the response sender.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PendingWatchlistReponse" }, "example": { "status": "pending", "tracking": "https://example-base-url/v1/sessions/f04bdb47-d3be-4b28-b028-a652feb060b5/watchlist-screening" } } } }, "400": { "description": "Bad request", "headers": { "Content-Type": { "description": "Response content type.", "schema": { "type": "string", "example": "application/json" } }, "X-AUTH-CLIENT": { "description": "API key echoed back in response.", "schema": { "type": "string" } }, "X-HMAC-SIGNATURE": { "description": "Response body signed with the shared secret key. Required to authenticate the response sender.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponse" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Response content type.", "schema": { "type": "string", "example": "application/json" } }, "X-AUTH-CLIENT": { "description": "API key echoed back in response.", "schema": { "type": "string" } }, "X-HMAC-SIGNATURE": { "description": "Response body signed with the shared secret key. Required to authenticate the response sender.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedErrorResponse" } } } }, "402": { "description": "PEP & Sanctions screening is not enabled for your integration" }, "404": { "description": "Session not found", "headers": { "Content-Type": { "description": "Response content type.", "schema": { "type": "string", "example": "application/json" } }, "X-AUTH-CLIENT": { "description": "API key echoed back in response.", "schema": { "type": "string" } }, "X-HMAC-SIGNATURE": { "description": "Response body signed with the shared secret key. Required to authenticate the response sender.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundErrorResponse" } } } }, "500": { "description": "Internal server error", "headers": { "Content-Type": { "description": "Response content type.", "schema": { "type": "string", "example": "application/json" } }, "X-AUTH-CLIENT": { "description": "API key echoed back in response.", "schema": { "type": "string" } }, "X-HMAC-SIGNATURE": { "description": "Response body signed with the shared secret key. Required to authenticate the response sender.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } } } } }, "components": { "schemas": { "WatchlistResponse": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "description": "API request status.", "example": "success" }, "data": { "description": "Data containing PEP & Sanctions result details.", "allOf": [ { "$ref": "#/components/schemas/WatchlistData" } ] } } }, "PendingWatchlistReponse": { "type": "object", "required": [ "status", "tracking" ], "properties": { "status": { "type": "string", "description": "API request status.", "example": "pending" }, "tracking": { "type": "string", "description": "Tracking URL to check screening progress.", "example": "https://example-base-url/v1/sessions/f04bdb47-d3be-4b28-b028-a652feb060b5/watchlist-screening" } } }, "BadRequestErrorResponse": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "fail" ], "example": "fail" }, "code": { "type": "string", "example": "1101" }, "message": { "type": "string", "example": "Validation failed" } }, "required": [ "status", "code", "message" ] }, "UnauthorizedErrorResponse": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "fail" ], "example": "fail" }, "code": { "type": "string", "example": "1101" }, "message": { "type": "string", "example": "Mandatory X-AUTH-CLIENT header containing the API key is missing from the request." } }, "required": [ "status", "code", "message" ] }, "NotFoundErrorResponse": { "type": "object", "required": [ "status", "code", "message" ], "properties": { "status": { "type": "string", "enum": [ "fail" ], "example": "fail" }, "code": { "type": "string", "example": "1101" }, "message": { "type": "string", "example": "Resource not found" } } }, "InternalServerErrorResponse": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "fail" ], "example": "fail" }, "code": { "type": "string", "example": "1101" }, "message": { "type": "string", "example": "Something went wrong" } }, "required": [ "status", "code", "message" ] }, "WatchlistData": { "type": "object", "required": [ "attemptId", "sessionId", "vendorData", "checkType", "matchStatus", "searchTerm", "totalHits", "createdAt", "hits" ], "properties": { "attemptId": { "type": "string", "format": "uuid", "description": "UUID v4 which identifies session attempt.", "example": "aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7" }, "sessionId": { "type": "string", "format": "uuid", "description": "UUID v4 which identifies session.", "example": "f04bdb47-d3be-4b28-b028-a652feb060b5" }, "vendorData": { "type": "string", "description": "The unique identifier that you created for your end-user. It can be max 1,000 characters long and contain only non-semantic data that can not be resolved or used outside your systems or environments. Veriff returns it unmodified in webhooks and API response payloads, or as `null` if not provided.\n", "example": "1234567890" }, "endUserId": { "type": "string", "format": "uuid", "description": "End-user-specific UUID created by the customer to identify the end-user. Returned unmodified in webhooks and public API calls, or as `null` if not provided.\n", "example": "c1de400b-1877-4284-8494-071d37916197" }, "checkType": { "type": "string", "description": "Indicates if the response is for the initial check or a subsequent check.\nRelevant only if ongoing-monitoring has been enabled for your integration.\n", "enum": [ "initial_result", "updated_result" ], "example": "initial_result" }, "matchStatus": { "type": "string", "description": "Indicates if there was a match in the database.", "enum": [ "possible_match", "no_match" ], "example": "possible_match" }, "monitorStatus": { "type": "string", "description": "Indicates if monitoring is enabled or disabled for this session, or empty if status is unknown.", "enum": [ "enabled", "disabled" ], "example": "enabled" }, "searchTerm": { "description": "Data used to perform the check.", "allOf": [ { "$ref": "#/components/schemas/SearchTerm" } ] }, "totalHits": { "type": "integer", "description": "Total number of hits returned from the check.", "example": "1" }, "createdAt": { "type": "string", "format": "date-time", "description": "Timestamp indicating when the check response was received.\n\nAs combined ISO 8601 date and time in UTC. Format: YYYY-MM-DDTHH:MM:SS.sssZ.\n", "example": "2021-07-05T13:23:59.851Z" }, "hits": { "type": "array", "description": "Array of records that were matched. Empty array if no hits were found.", "items": { "$ref": "#/components/schemas/PepSanctionMatchHit" } } } }, "SearchTerm": { "type": "object", "required": [ "name", "year" ], "properties": { "name": { "type": "string", "description": "Full name used during the check.", "example": "GADDAFI" }, "year": { "type": "string", "description": "Birth year used during the check.", "example": "1942" }, "lists": { "type": "array", "description": "List of watchlists against which the check was performed. Available only for [enhanced AML solution](https://devdocs.veriff.com/docs/aml-screening-solution).", "items": { "type": "string" }, "example": [ "SANCTIONS", "PEP_CLASS_1", "PEP_CLASS_2" ] }, "countries": { "type": "array", "description": "List of countries associated with the check. Available only for [enhanced AML solution](https://devdocs.veriff.com/docs/aml-screening-solution).", "items": { "type": "string" }, "example": [ "US", "GB", "FR" ] }, "exactMatch": { "type": "boolean", "description": "Indicates whether the name used in the check required an exact match. Available only for [enhanced AML solution](https://devdocs.veriff.com/docs/aml-screening-solution).", "example": "false" }, "matchThreshold": { "type": "integer", "minimum": "0", "maximum": "100", "description": "Name match sensitivity on a 0–100 scale, indicates how much variation should be allowed from the end-user's data in the results. Available only for [enhanced AML solution](https://devdocs.veriff.com/docs/aml-screening-solution).", "example": "80" }, "excludeDeceased": { "type": "boolean", "description": "Indicates whether deceased individuals were excluded from the check. Available only for [enhanced AML solution](https://devdocs.veriff.com/docs/aml-screening-solution).", "example": "true" } } }, "PepSanctionMatchHit": { "type": "object", "required": [ "matchedName", "countries", "dateOfBirth", "dateOfDeath", "matchTypes", "aka", "associates", "listingsRelatedToMatch" ], "properties": { "matchedName": { "type": "string", "description": "The name that was matched in this hit based on the search term.", "example": "Mouammar Mohammed Abu Minyar Kadhafi" }, "countries": { "type": "array", "description": "List of countries that the sources listed in relation to this hit.", "items": { "type": "string" }, "example": [ "Australia", "Brazil" ] }, "dateOfBirth": { "type": "string", "description": "Birth date of the person in the matched listings.", "example": "1942" }, "dateOfDeath": { "type": "string", "nullable": "true", "description": "Death date of the person in the matched listings.", "example": "2011" }, "matchTypes": { "type": "array", "description": "Array that shows the match type in the listings.\n\nSee the [data provider's documentation](https://docs.complyadvantage.com/) for more detailed info.\n", "items": { "type": "string" }, "example": [ "matching_name" ] }, "aka": { "type": "array", "description": "Array of names that the matched person is also known as.", "items": { "type": "string" }, "example": [ "Moamarr Qaddafi" ] }, "associates": { "type": "array", "description": "Array of names that the matched person is associated with.", "items": { "type": "string" }, "example": [] }, "listingsRelatedToMatch": { "description": "Matched listings. Empty object if addon \"PEP & Sanctions check\" is not enabled.", "allOf": [ { "$ref": "#/components/schemas/PepSanctionRelatedListings" } ] } } }, "PepSanctionRelatedListings": { "type": "object", "properties": { "warnings": { "type": "array", "description": "Array of warning-related listings.", "items": { "$ref": "#/components/schemas/RelatedListingsProperties1" } }, "sanctions": { "type": "array", "description": "Array of sanctions-related listings.", "items": { "$ref": "#/components/schemas/RelatedListingsProperties1" } }, "fitnessProbity": { "type": "array", "description": "Array of fitness and probity-related listings.", "items": { "$ref": "#/components/schemas/RelatedListingsProperties1" } }, "pep": { "type": "array", "description": "Array of PEP-related listings.", "items": { "$ref": "#/components/schemas/RelatedListingsProperties1" } }, "adverseMedia": { "type": "array", "description": "Array of adverse media-related listings.", "items": { "$ref": "#/components/schemas/RelatedListingsProperties2" } } } }, "RelatedListingsProperties1": { "type": "object", "required": [ "sourceName" ], "properties": { "sourceName": { "type": "string", "description": "Source name of the related listing.", "example": "ComplyAdvantage PEP data" }, "sourceUrl": { "type": "string", "nullable": "true", "description": "Source URL of the related listing." }, "date": { "type": "string", "nullable": "true", "description": "Date of the related listing." } } }, "RelatedListingsProperties2": { "type": "object", "required": [ "sourceName" ], "properties": { "sourceName": { "type": "string", "description": "Source name of the related listing.", "example": "ComplyAdvantage PEP data" }, "snippet": { "type": "string", "description": "Text snippet from the source listing.", "example": "Sang Tan Judges in the High Court in London have ruled that Saleh Ibrahim Mabrouk, a former aide of Libyan leader Colonel Muammar Gaddafi, was partly to blame for the murder of PC Yvonne Fletcher. The gunman" }, "sourceUrl": { "type": "string", "nullable": "true", "description": "Source URL of the related listing." }, "date": { "type": "string", "nullable": "true", "description": "Date of the related listing." } } } } } } ````