{ "openapi": "3.0.1", "info": { "title": "Cross-Border Restricted Party Evidence", "description": "Screen up to 100 party names against the official U.S. ITA Consolidated Screening List with exact or conservative fuzzy review, source hashes, change monitoring, caller-owned dispositions, and decision and batch receipts. No legal-clearance claim.", "version": "0.1", "x-build-id": "BTwNFyapfIZzuYGhI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/civicdataforge~cross-border-restricted-party-evidence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-civicdataforge-cross-border-restricted-party-evidence", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/civicdataforge~cross-border-restricted-party-evidence/runs": { "post": { "operationId": "runs-sync-civicdataforge-cross-border-restricted-party-evidence", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/civicdataforge~cross-border-restricted-party-evidence/run-sync": { "post": { "operationId": "run-sync-civicdataforge-cross-border-restricted-party-evidence", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "queries" ], "properties": { "queries": { "title": "Parties to screen", "minItems": 1, "maxItems": 100, "type": "array", "description": "One to 100 party-name queries. Country and address are review context and never turn a name candidate into legal clearance.", "items": { "type": "object", "properties": { "reference": { "title": "Caller reference", "type": "string", "maxLength": 200, "description": "Optional non-sensitive identifier returned with the result." }, "name": { "title": "Party name", "type": "string", "minLength": 2, "maxLength": 300, "description": "Required legal, trading, or known alias name." }, "country": { "title": "Country code", "type": "string", "description": "Optional ISO alpha-2 country code used only for review consistency." }, "address": { "title": "Address", "type": "string", "maxLength": 500, "description": "Optional address fragment used only for review consistency." }, "previousDecisionReceiptHash": { "title": "Previous decision receipt", "type": "string", "description": "Optional prior CivicDataForge receipt used only for change classification." }, "previousRecordFingerprints": { "title": "Previous matched fingerprints", "type": "array", "editor": "stringList", "maxItems": 10, "description": "Optional prior matched-record fingerprints used to distinguish unchanged, changed, and no-longer-present observations.", "items": { "type": "string" } }, "reviewDisposition": { "title": "Caller review disposition", "type": "string", "editor": "select", "enum": [ "NOT_REVIEWED", "CLEARED_FALSE_POSITIVE", "CONFIRMED_MATCH", "ESCALATED" ], "default": "NOT_REVIEWED", "description": "Caller-asserted workflow state. It never changes the screening decision or creates legal clearance." }, "reviewReference": { "title": "Review reference", "type": "string", "maxLength": 200, "description": "Optional non-sensitive case reference. Do not include confidential case notes or personal data." } }, "required": [ "name" ] } }, "matchMode": { "title": "Name match mode", "enum": [ "exact", "fuzzy" ], "type": "string", "description": "Exact normalized-name matching, or exact matching plus conservative fuzzy review candidates.", "default": "fuzzy" }, "minimumScore": { "title": "Minimum fuzzy score", "minimum": 85, "maximum": 100, "type": "integer", "description": "Candidate threshold from 85 to 100. The score is a review aid, never an ITA endorsement or legal determination.", "default": 92 }, "maxCandidatesPerQuery": { "title": "Maximum candidates per query", "minimum": 1, "maximum": 10, "type": "integer", "description": "Hard cap from one to ten review candidates returned for each submitted party name.", "default": 5 }, "previousSourceSha256": { "title": "Previous source snapshot hash", "type": "string", "description": "Optional SHA-256 from a prior run. The output reports whether the complete official CSL snapshot changed." }, "batchReference": { "title": "Batch reference", "maxLength": 200, "type": "string", "description": "Optional non-sensitive caller reference bound into the batch receipt." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }