{ "openapi": "3.0.1", "info": { "title": "LEIE Exclusion Evidence API (OIG + NPI + SAM)", "description": "Source-linked OIG LEIE screening with valid-NPI exact matches, state-bound name review candidates, optional NPPES/SAM checks, and evidence hashes. No eligibility decisions.", "version": "0.1", "x-build-id": "3ycdXkTCMnk4IdjS7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/civicdataforge~leie-exclusion-screening/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-civicdataforge-leie-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/civicdataforge~leie-exclusion-screening/runs": { "post": { "operationId": "runs-sync-civicdataforge-leie-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/civicdataforge~leie-exclusion-screening/run-sync": { "post": { "operationId": "run-sync-civicdataforge-leie-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": [ "screen", "filter" ], "type": "string", "description": "screen checks people/entities and returns evidence records; filter pulls source LEIE records with provenance.", "default": "screen" }, "screenList": { "title": "People / entities to screen", "maxItems": 500, "type": "array", "description": "For screen mode. Each item: { \"name\": \"JOHN SMITH\" or \"ACME HOME HEALTH\", \"npi\": \"1234567893\" (optional valid test NPI), \"state\": \"NC\" (optional), \"ref\": \"your-id\" (optional) }. Name-only matches are normalized exact-name candidates, constrained by state when supplied, and require human review.", "items": { "type": "object", "properties": { "name": { "title": "Name", "type": "string", "minLength": 1, "description": "Person or entity name. Required when NPI is omitted." }, "npi": { "title": "NPI", "type": "string", "pattern": "^[0-9]{10}$", "description": "Optional 10-digit NPI. The Actor also validates the NPI check digit and rejects invalid values." }, "state": { "title": "State", "type": "string", "pattern": "^[A-Za-z]{2}$", "description": "Optional two-letter state used to constrain name candidates." }, "ref": { "title": "Caller reference", "type": "string", "description": "Optional caller reference returned with the evidence record." } } }, "default": [] }, "enrichNpi": { "title": "Resolve identity with CMS NPPES", "type": "boolean", "description": "Look up matched LEIE NPIs or a caller-supplied NPI in the official CMS registry and return explainable correlation signals. NPI status is not licensure or eligibility.", "default": true }, "maxNpiLookups": { "title": "Maximum CMS NPI lookups", "minimum": 0, "maximum": 25, "type": "integer", "description": "Caps NPPES calls per run. Remaining rows still receive LEIE results and show that enrichment was skipped.", "default": 10 }, "includeSam": { "title": "Also check SAM.gov active exclusions", "type": "boolean", "description": "Opt in to the official GSA SAM.gov Exclusions API. Requires your own public SAM.gov API key.", "default": false }, "samApiKey": { "title": "SAM.gov API key", "type": "string", "description": "Caller-supplied SAM.gov public API key. Required only when includeSam is enabled; never returned in output." }, "maxSamQueries": { "title": "Maximum SAM.gov queries", "minimum": 0, "maximum": 10, "type": "integer", "description": "Caps SAM.gov calls per run to respect the official API's role-dependent rate limits.", "default": 10 }, "caseWorkflow": { "title": "Create portable review cases", "type": "boolean", "description": "Screen mode only. Writes a CASE-BUNDLE record whose evidence references, dispositions, and hash-chained transitions can be verified outside CivicDataForge. Raw subject keys are hashed in the case file.", "default": false }, "priorCases": { "title": "Prior customer-owned cases", "maxItems": 500, "type": "array", "description": "Optional prior CASE-BUNDLE cases for continuity. Receipts are verified; changed evidence reopens a resolved case. Keep this state in your own system and send back only the cases in the current batch.", "items": { "type": "object" }, "default": [] }, "caseActions": { "title": "Audited case dispositions", "maxItems": 500, "type": "array", "description": "Optional optimistic-lock transitions. Each action requires case_id, expected_case_receipt, expected_version, to_status, actor_ref, reason, and at. Stale or forged writes fail closed.", "items": { "type": "object" }, "default": [] }, "webhookUrl": { "title": "Case bundle webhook", "type": "string", "description": "Optional public HTTPS endpoint. Delivery uses a stable event ID, an HMAC signature, up to three attempts, and a redacted WEBHOOK-DELIVERY receipt." }, "webhookSecret": { "title": "Webhook signing secret", "type": "string", "description": "At least 16 characters. Used only to sign the exact webhook body and never written to output." }, "state": { "title": "State (filter mode)", "type": "string", "description": "Two-letter state code, for example TX." }, "specialty": { "title": "Specialty (filter mode)", "type": "string", "description": "Substring match on specialty, such as NURSING, PHARMACY, or HOME HEALTH." }, "exclusionType": { "title": "Exclusion type (filter mode)", "type": "string", "description": "OIG exclusion authority code, such as 1128a1 or 1128b5." }, "maxRecords": { "title": "Max records (filter mode)", "minimum": 1, "type": "integer", "description": "Caps LEIE records returned in filter mode.", "default": 100 } } }, "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 } } } } } } } } } }