{ "openapi": "3.0.1", "info": { "title": "UFLPA Forced Labor Screening: Supplier Entity List Check", "description": "Screen suppliers against the DHS UFLPA Entity List and CBP Withhold Release Orders, with Chinese name matching, Xinjiang and UFLPA sector flags and the DOL List of Goods.", "version": "0.1", "x-build-id": "wnLPCciiPWveW3iEz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/reliable_tools~uflpa-forced-labor-screening/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-reliable_tools-uflpa-forced-labor-screening", "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/reliable_tools~uflpa-forced-labor-screening/runs": { "post": { "operationId": "runs-sync-reliable_tools-uflpa-forced-labor-screening", "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/reliable_tools~uflpa-forced-labor-screening/run-sync": { "post": { "operationId": "run-sync-reliable_tools-uflpa-forced-labor-screening", "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", "properties": { "suppliers": { "title": "Suppliers", "type": "array", "description": "One object per supplier. Fields: \"name\" (required, any script, for example Chinese characters), \"reference\", \"aliases\" (list or text separated by ;), \"country\", \"address\", \"products\" (list or text) and \"hsCodes\" (list or text). Products and HS codes enable the UFLPA sector and DOL List of Goods checks. The prefill is sample data." }, "supplierNames": { "title": "Supplier names (quick list)", "type": "array", "description": "Optional: plain supplier names, one per line, screened by name only.", "items": { "type": "string" } }, "csvUrl": { "title": "CSV file URL", "type": "string", "description": "Optional: a link to a CSV file with a header row. Recognised columns: name (or supplier, company), reference, aliases, country, address, products, hsCodes (or hs, hts)." }, "aiChecks": { "title": "AI match checks", "type": "boolean", "description": "Every similar listed name gets a same, related or different verdict with a probability, and products are checked against UFLPA sectors and DOL goods. Off: name rules and HS code or keyword checks only, and the AI match event is not charged.", "default": true }, "includeDolList": { "title": "Include the DOL List of Goods", "type": "boolean", "description": "Adds goods from the US Department of Labor List of Goods Produced by Child Labor or Forced Labor for the supplier country.", "default": true }, "minNameScore": { "title": "Minimum name similarity", "minimum": 60, "maximum": 100, "type": "integer", "description": "Listed names below this similarity (0 to 100) are not reviewed, unless they share a distinctive word with the supplier name. Lower finds more variants and costs nothing extra.", "default": 78 }, "maxCandidatesPerList": { "title": "Max similar names per list", "minimum": 1, "maximum": 15, "type": "integer", "description": "How many of the most similar listed names per list are reviewed for each supplier.", "default": 5 }, "likelyMatchThreshold": { "title": "Match threshold", "minimum": 0.5, "maximum": 0.99, "type": "number", "description": "Same-entity probability from which a candidate counts as a match (and the supplier as listed).", "default": 0.75 }, "reviewThreshold": { "title": "Review threshold", "minimum": 0.05, "maximum": 0.75, "type": "number", "description": "Same-entity probability from which a candidate is reported as a possible match for human review.", "default": 0.3 }, "maxSuppliers": { "title": "Max suppliers per run", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Stops after this many suppliers.", "default": 5000 }, "forceRefresh": { "title": "Download lists again", "type": "boolean", "description": "Lists are cached for 24 hours (the DOL list for 14 days). Turn on to download every list fresh for this run.", "default": false } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }