> ## Documentation Index
> Fetch the complete documentation index at: https://docs.parcha.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# Vendor Data Integration
> How to submit pre-existing vendor screening data to Parcha agents
## Overview
When using certain Parcha agents (such as the IG AML Agent with `ig-aml-vendor-v1-demo`), you can provide pre-existing screening data from compliance vendors like ComplyAdvantage or Refinitiv. This allows you to leverage data you've already collected while still benefiting from Parcha's advanced analysis and risk assessment capabilities.
When configured with `use_vendor_data_only = true`, the agent will not make fresh API calls to vendor services and will only process the vendor data included in your request.
## How It Works
When you provide vendor data:
1. The agent skips vendor API calls (no fresh data fetching)
2. Uses the vendor data provided in your request
3. Still processes all weblinks in the vendor data:
* Scrapes and analyzes article content
* Extracts metadata from articles
* Determines risk factors if not provided
* Augments profiles with extracted information
4. Cross-references vendor hits with web presence data
5. Generates risk ratings based on the analysis
The `use_vendor_data_only` flag only prevents new vendor API calls. All other processing (weblink scraping, LLM analysis, profile augmentation) still occurs.
## Vendor Data Specifications
### Adverse Media Screening Data
Include adverse media profiles found by your vendor in the `adverse_media_event_check` section:
```json theme={null}
{
"adverse_media_event_check": {
"vendor_data": {
"vendor_case_id": "CA-123456",
"vendor_case_internal_id": "abc12",
"search_term": "John Doe",
"vendor_adverse_media_profiles": [
{
// Required fields
"id": "profile-001",
"full_name": "John Doe",
// Recommended fields
"associated_countries": ["USA", "GBR"],
"associated_addresses": ["123 Main St, NYC"],
"date_of_birth": "1990-01-01",
"weblinks": [
{
"id": "link-001",
"title": "News Article",
"url": "https://example.com/article"
}
],
// Optional fields
"forename": "John",
"surname": "Doe",
"middle_name": "Michael",
"aliases": ["J. Doe", "Johnny Doe"],
"title": "Financial Fraud Investigation",
"summary": "Involved in 2023 fraud case",
"when": "2023-06-15",
"topics": ["financial_crime", "fraud"],
"age_as_of_today": 34,
"gender": "male",
"occupation": ["Business Executive"],
"identification_info": "Passport: US123456",
"biography_info": "Former executive at..."
}
]
}
}
}
```
**Required Fields:**
* `id`: Unique identifier for the profile
* `full_name`: Full name used for matching
**Recommended Fields:**
* `associated_countries`: Countries mentioned in adverse media
* `associated_addresses`: Addresses mentioned
* `date_of_birth`: For age verification (YYYY-MM-DD format)
* `weblinks`: Source articles that will be processed
**Optional Fields:**
* Name components: `forename`, `surname`, `middle_name`
* `aliases`: Alternative names
* Event details: `title`, `summary`, `when`, `topics`
* Demographics: `age_as_of_today`, `gender`, `occupation`
* `identification_info`: ID documents mentioned
* `biography_info`: Background information
### PEP Screening Data
Include PEP (Politically Exposed Person) matches in the `pep_screening_check_v2` section:
```json theme={null}
{
"pep_screening_check_v2": {
"vendor_data": {
"vendor_case_id": "CA-789012",
"vendor_case_internal_id": "def34",
"search_term": "John Doe",
"potential_pep_hits": [
{
// Required fields
"id": "pep-001",
"full_name": "John Michael Doe",
// Recommended fields
"pep_type": "foreign",
"pep_status": "current",
"pep_title": "Deputy Minister of Finance",
"associated_countries": ["GBR", "USA"],
"date_of_birth": "1990-01-01",
"roles": [
{
"title": "Deputy Minister of Finance",
"start_date": "2020-01-01",
"end_date": null,
"pep_type": "foreign",
"status": "current"
}
],
// Optional fields
"forename": "John",
"middle_name": "Michael",
"surname": "Doe",
"aliases": ["J. Doe", "John M. Doe"],
"associated_addresses": ["10 Downing St"],
"location": "London, UK",
"has_adverse_media": false,
"biography_info": "Appointed in 2020...",
"identification_info": "Passport: GB123456",
"gender": "male",
"age_as_of_today": 34,
"known_associates": [
{
"name": "Jane Doe",
"association_type": "spouse",
"entity_type": "person"
}
],
"relationships": [],
"weblinks": [
{
"id": "link-001",
"title": "Official Biography",
"url": "https://gov.uk/minister/doe"
}
]
}
]
}
}
}
```
**Required Fields:**
* `id`: Unique identifier
* `full_name`: Full name for matching
**Recommended Fields:**
* `pep_type`: Values: `domestic`, `foreign`, `international_org`
* `pep_status`: Values: `current`, `former`
* `pep_title`: Official title
* `associated_countries`: Countries of operation
* `date_of_birth`: For verification
* `roles`: Array of political roles with dates
**Optional Fields:**
* Name components and aliases
* Location information
* `has_adverse_media`: Boolean flag
* Biography and identification details
* `known_associates`: Associated persons/entities
* `relationships`: Related PEP profiles
### Sanctions Screening Data
Include sanctions matches in the `sanctions_screening_check_v2` section:
```json theme={null}
{
"sanctions_screening_check_v2": {
"vendor_data": {
"vendor_case_id": "CA-345678",
"vendor_case_internal_id": "ghi56",
"search_term": "John Doe",
"potential_sanctions_hits": [
{
// Required fields
"id": "sanc-001",
"full_name": "John Doe",
// Recommended fields
"associated_countries": ["IRN", "SYR"],
"date_of_birth": "1990-01-01",
"sanction_details": [
{
"title": "OFAC SDN List",
"detail": "Added for Iran sanctions violations",
"jurisdiction": "USA",
"list_date": "2023-01-15"
}
],
// Optional fields
"forename": "John",
"surname": "Doe",
"middle_name": "Michael",
"aliases": ["J. Doe"],
"native_character_names": ["جان دو"],
"associated_addresses": ["Tehran, Iran"],
"location": "Tehran, Iran",
"biography_info": "Business executive...",
"identification_info": "Passport: IR123456",
"gender": "male",
"age_as_of_today": 34,
"known_associates": [
{
"name": "ABC Trading Co",
"association_type": "business",
"entity_type": "organization"
}
],
"relationships": [],
"reports_origin": [
"OFAC SDN List Entry: Added 2023-01-15"
],
"weblinks": [
{
"id": "link-001",
"title": "OFAC SDN Entry",
"url": "https://sanctionssearch.ofac.treas.gov/Details.aspx?id=12345"
}
]
}
]
}
}
}
```
**Required Fields:**
* `id`: Unique identifier
* `full_name`: Full name for matching
**Recommended Fields:**
* `associated_countries`: Sanctioning countries
* `date_of_birth`: For verification
* `sanction_details`: Array of sanction information with jurisdiction and dates
**Optional Fields:**
* Name components and aliases
* `native_character_names`: Names in native script
* Location and biographical information
* `known_associates`: Associated entities
* `reports_origin`: Source information
## Complete Example Request
Here's a full example showing how to submit vendor data for all three screening types:
```json theme={null}
{
"agent_key": "ig-aml-vendor-v1-demo",
"payload": {
"id": "case-2024-001",
"self_attested_data": {
"first_name": "John",
"middle_name": "Michael",
"last_name": "Doe",
"date_of_birth": "1990-01-01",
"sex": "male",
"email": "john.doe@example.com",
"phone": "+1-555-123-4567",
"address": {
"street_1": "123 Main Street",
"street_2": "Apt 4B",
"city": "New York",
"state": "NY",
"country_code": "US",
"postal_code": "10001"
},
"country_of_nationality": "USA",
"country_of_residence": "USA"
},
"adverse_media_event_check": {
"vendor_data": {
"vendor_case_id": "CA-ADV-123",
"search_term": "John Doe",
"vendor_adverse_media_profiles": [
{
"id": "adv-001",
"full_name": "John Doe",
"date_of_birth": "1990-01-01",
"is_perpetrator": false,
"topics": ["financial_crime"],
"associated_countries": ["USA"],
"weblinks": [
{
"id": "link-002",
"title": "Court Document",
"url": "https://example.com/court-doc"
}
]
}
]
}
},
"pep_screening_check_v2": {
"vendor_data": {
"vendor_case_id": "CA-PEP-456",
"search_term": "John Doe",
"potential_pep_hits": []
}
},
"sanctions_screening_check_v2": {
"vendor_data": {
"vendor_case_id": "CA-SANC-789",
"search_term": "John Doe",
"potential_sanctions_hits": []
}
}
}
}
```
## Important Notes
### General Guidelines
* **Empty Results**: Use empty arrays (`[]`) when no matches are found
* **Date Formats**: Use ISO 8601 format (YYYY-MM-DD)
* **Country Codes**: Use ISO 3166-1 alpha-3 codes (USA, GBR, etc.)
* **Topics**: Use standardized topic categories (e.g., "financial\_crime", "fraud", "money\_laundering")
### Field Requirements
1. **Minimal Required Fields**:
* `id`: Unique identifier (auto-generated if not provided)
* `full_name`: Critical for name matching
* Other fields default to empty arrays/null if not provided
2. **Critical Fields for Risk Assessment**:
* `is_perpetrator`: For adverse media - indicates if person was perpetrator vs victim/witness
* `associated_countries`: For geographic matching
* `topics`: For adverse media categorization
* `date_of_birth`: For age/identity verification
* `weblinks`: Source articles that will be scraped and processed
### Processing Behavior
When you provide vendor data:
* The agent will still process and analyze all weblinks
* Missing fields like `is_perpetrator` will be determined through analysis
* The agent will augment and enrich the vendor data with additional findings
* Cross-referencing with web presence data still occurs for validation
The vendor data integration feature allows you to leverage existing screening data while still benefiting from Parcha's advanced analysis, cross-referencing, and risk assessment capabilities.