Single Name Scan

Single Name Scan Endpoints

Create Single Name Scan

Perform a real-time scan of a single name or entity.

Endpoint: POST /api/v1/ScanManualRequest/CreateSingleScan

Request Body:

{
  "SearchString": "Vladimir Putin",
  "Type": 0,
  "UserName": "api_user",
  "ScanListIds": ["PEP_LIST", "OFAC_SDN"],
  "SearchLevel": 3,
  "SimilarityThreshold": 85,
  "Memo": "High-risk customer screening",
	"DateOfBirth": "XXXXXX",
  "TaxId": "XXXXXX"
}

Response:

{
  "searchId": "770e8400-e29b-41d4-a716-446655440003",
  "status": "Completed",
  "matchCount": 5,
  "processingTime": "1.2 seconds"
}

Field Descriptions:

Field	Type	Required	Description
SearchString	string	Yes	Name, ID, or entity to scan
Type	integer	Yes	0=Name, 1=ID, 2=Organization, 3=Address, 4=Vessel, 5=Aircraft
UserName	string	Yes	User identifier for logging
ScanListIds	array	Yes	Watchlists to scan against
SearchLevel	integer	Yes	1=Exact, 2=Exact Any Order, 3=Similarity
SimilarityThreshold	integer	No	Match threshold 0-100 (for SearchLevel=3)
Memo	string	No	Notes for this scan

Get Single Scan Results

Retrieve results from a single name scan.

Endpoint: GET /api/v1/ScanManualRequest/Results/{searchId}/{page}/{numOfRecordsPerPage}

Path Parameters:

searchId (string, required): Search ID from CreateSingleScan
page (integer, required): Page number (1-based)
numOfRecordsPerPage (integer, required): Records per page

Response:

{
  "searchId": "770e8400-e29b-41d4-a716-446655440003",
  "searchString": "Vladimir Putin",
  "results": [
    {
      "matchScore": 100,
      "watchlistName": "PEP Global Leaders",
      "matchedName": "Vladimir Vladimirovich Putin",
      "listType": "PEP",
      "pepLevel": "Level1",
      "pepType": "Government",
      "pepCountry": "RU",
      "matchDetails": {
        "position": "President",
        "since": "2000",
        "description": "Head of State - Russian Federation"
      }
    }
  ]
}