Skip to main content
Retrieves a complete name screening search including its status, input fields, and all matching hits.

​
Response Structure

The search response includes:
  • Search metadata: ID, reference, status, and timestamps
  • Input fields: The subject’s information used for screening
  • Hit counts: Number of hits by status (FALSE_POSITIVE, TRUE_POSITIVE, UNRESOLVED)
  • Hits: Array of screening matches, each containing:
    • Hit ID, provider reference, and provider URL
    • Hit status (FALSE_POSITIVE, TRUE_POSITIVE, UNRESOLVED)
    • Hit fields with match details
    • Hit categories (SANCTION, PEP, MEDIA)
    • Remediation data with AI analysis and resolution
Example response: 
{
  "id": "d6e3b214-30b1-4401-a1b8-a1bd3c6a84e4",
  "reference": "CUST-2024-001",
  "status": "COMPLETED",
  "input": [
    {"label": "Name", "value": "John Doe"}
  ],
  "hit_counts": {
    "FALSE_POSITIVE": 2,
    "TRUE_POSITIVE": 1,
    "UNRESOLVED": 3
  },
  "hits": [
    {
      "id": "hit-001",
      "provider_reference": "WC-12345",
      "provider_url": "https://worldcheck.com/...",
      "status": "UNRESOLVED",
      "fields": [...],
      "hit_categories": ["SANCTION"],
      "remediation": null
    }
  ],
  "created_at": "2024-10-02T12:00:00Z",
  "updated_at": "2024-10-02T14:30:00Z"
}

​
Search Status

Monitor the status field to track search progress:
  • PENDING - Search created, provider query in progress
  • COMPLETED - Search finished, hits available
  • FAILED - Provider query failed

​
Working with Hits

Each hit in the response includes:
  • provider_reference: Provider’s identifier for this match
  • provider_url: Direct link to the match in provider’s system
  • status: Resolution status (UNRESOLVED by default)
  • fields: Match details and confidence scores
  • hit_categories: Type of match (SANCTION, PEP, MEDIA)
  • remediation: AI analysis with determination and evidence

​
Typical Flow

  1. Create search and receive search ID
  2. Poll search endpoint to check status
  3. When status is COMPLETED, review hits array
  4. Access remediation data for AI-generated analysis