{ "openapi": "3.0.1", "info": { "title": "OIG LEIE & SAM Exclusion Screening API: 49 Official Lists", "description": "Screen employees, providers and vendors against the federal OIG LEIE, SAM.gov exclusions, and state Medicaid exclusion lists, with match scores, provenance and list freshness. Built for the OIG-mandated monthly re-screening cycle.", "version": "0.1", "x-build-id": "gU8V1lVka7hLulvXF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/friendlyapi~healthcare-exclusion-screening/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-friendlyapi-healthcare-exclusion-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/friendlyapi~healthcare-exclusion-screening/runs": { "post": { "operationId": "runs-sync-friendlyapi-healthcare-exclusion-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/friendlyapi~healthcare-exclusion-screening/run-sync": { "post": { "operationId": "run-sync-friendlyapi-healthcare-exclusion-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": { "mode": { "title": "Mode", "enum": [ "search", "screen_roster", "lists" ], "type": "string", "description": "search = screen one party; screen_roster = batch screen a list; lists = show dataset freshness (free)", "default": "lists" }, "last_name": { "title": "Last name", "type": "string", "description": "Individual's last name (search mode)" }, "first_name": { "title": "First name", "type": "string", "description": "Individual's first name (search mode)" }, "business_name": { "title": "Business name", "type": "string", "description": "Organization/entity name (search mode)" }, "npi": { "title": "NPI", "type": "string", "description": "10-digit National Provider Identifier, strongest match signal" }, "min_score": { "title": "Minimum match score", "minimum": 0, "maximum": 1, "type": "number", "description": "0.6 (looser, review-oriented) to 1.0 (exact only). Default 0.6 for search, 0.75 for rosters. Changing it between monitored runs suppresses 'cleared' for that run, because a different threshold is not evidence that a party came off a list.", "default": 0.75 }, "parties": { "title": "Roster (screen_roster mode)", "type": "array", "description": "List of parties. Give each a stable 'id' of your own: [{\"id\": \"emp-1\", \"last_name\": \"...\", \"first_name\": \"...\"}, {\"id\": \"vend-1\", \"business_name\": \"...\"}]. The id is required when monitor_id is set, because positional ordering would attribute one person's exclusion to another if the roster is reordered." }, "monitor_id": { "title": "Monitor ID (screen_roster mode)", "type": "string", "description": "Stable name for this roster (e.g. 'main-staff'). Required for change tracking, along with your own 'id' on every party. Runs with the same monitor_id report what CHANGED since the previous run. Omit for a one-off screen with no change tracking." } } }, "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 } } } } } } } } } }