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:

{
  "UserName": "UserName",
  "ScanListIds": ["508fd1110fae1d1ac0c21d36"],
  "Memo": "OFAC Scan",
  "NumOfRecords": 1,
  "SearchLevel": 3,
  "SimilarityThreshold": 95,
  "TransactionType": "",
  "SearchString": "{{search_entity_name}}",
  "Type": 0
}

Response:

"{{scan_id}}"

Field Descriptions:

FieldTypeRequiredDescription
SearchStringstringYesName, ID, or entity to scan
TypeintegerYes0=Name, 1=ID, 2=Organization, 3=Address, 4=Vessel, 5=Aircraft
UserNamestringYesUser identifier for logging
ScanListIdsarrayYesWatchlists to scan against
SearchLevelintegerYes1=Exact, 2=Exact Any Order, 3=Similarity
SimilarityThresholdintegerNoMatch threshold 0-100 (for SearchLevel=3)
MemostringNoNotes 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:

{
    "Results": [
        {
            "SearchRecordId": "6a1ee719b96ce167e6a5dd90",
            "UniqueID": "SingleSearchTuesday, June 2, 2026",
            "SearchName": "Vladimir Putin",
            "SearchAddress": null,
            "CompositeReferenceId": "6a1ee713b96ce167e6a59153",
            "Matches": [
                {
                    "MatchName": "VLADIMIR PUTIN",
                    "FullName": "VLADIMIR VLADIMIROVICH PUTIN",
                    "MatchType": "",
                    "Similarity": 100,
                    "MatchLevel": 3,
                    "MatchField": "AKA",
                    "WatchListName": "OFAC SDN and Consolidated",
                    "WatchListID": "35096",
                    "MainAddress": "Kremlin, Moscow, Russia",
                    "AKAs": [
                        "VLADIMIR PUTIN"
                    ],
                    "AdditionalDetails": [
                        {
                            "Label": "DOB",
                            "Data": "07 Oct 1952"
                        },
                        {
                            "Label": "POB",
                            "Data": "Leningrad, Russia"
                        },
                        {
                            "Label": "Address 0",
                            "Data": "Kremlin Moscow Russia "
                        },
                        {
                            "Label": "Address 1",
                            "Data": "Novo-Ogaryevo Moscow Region Russia "
                        },
                        {
                            "Label": "Address 2",
                            "Data": "Bocharov Ruchey Sochi Russia "
                        },
                        {
                            "Label": "Address 3",
                            "Data": "Valdai Novgorod Region Russia "
                        },
                        {
                            "Label": "Citizenship",
                            "Data": "Russia"
                        },
                        {
                            "Label": "Identification 0",
                            "Data": "Type: Secondary sanctions risk: Number: See Section 11 of Executive Order 																	14024. "
                        },
                        {
                            "Label": "Identification 1",
                            "Data": "Type: Gender Number: Male "
                        },
                        {
                            "Label": "Nationality",
                            "Data": "Russia"
                        },
                        {
                            "Label": "Program",
                            "Data": "RUSSIA-EO14024"
                        },
                        {
                            "Label": "Type",
                            "Data": "Individual"
                        },
                        {
                            "Label": "Title",
                            "Data": "President of the Russian Federation"
                        },
                        {
                            "Label": "ID",
                            "Data": "35096"
                        }
                    ],
                    "HashKey": 485514552
                }
            ]
        }
    ],
    "TotalPotentialMatches": 1
}