{ "openapi": "3.0.1", "info": { "title": "Healthcare Provider Credential Check (NPI + OIG LEIE + SAM.gov)", "description": "Verify US healthcare providers in one call: confirms the NPI in CMS NPPES, screens the HHS-OIG LEIE exclusion list (optionally SAM.gov), cross-checks a license number, and returns one clear / excluded / review / not_found verdict with evidence. Built for AI agents; pay per provider.", "version": "0.1", "x-build-id": "qt0H6REL7i46c2vAm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/golden_shores_agentics~provider-credential-check/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-golden_shores_agentics-provider-credential-check", "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/golden_shores_agentics~provider-credential-check/runs": { "post": { "operationId": "runs-sync-golden_shores_agentics-provider-credential-check", "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/golden_shores_agentics~provider-credential-check/run-sync": { "post": { "operationId": "run-sync-golden_shores_agentics-provider-credential-check", "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": { "npis": { "title": "NPIs", "type": "array", "description": "List of 10-digit National Provider Identifiers to check. Fastest and most accurate input. Example: [\"1234567893\"]. Use `providers` instead when you only have names.", "items": { "type": "string", "pattern": "^\\d{10}$" } }, "providers": { "title": "Providers (by name or NPI)", "type": "array", "description": "Array of provider objects. Each object may contain: npi (10 digits), firstName, lastName, organizationName, state (2-letter), dob (YYYY-MM-DD), licenseNumber (compared with NPPES-reported licenses), ref (any string echoed back in the result). Provide npi OR lastName (+firstName, state, dob) OR organizationName.", "items": { "type": "object", "properties": { "npi": { "type": "string", "title": "NPI", "description": "10-digit National Provider Identifier (preferred).", "editor": "textfield", "pattern": "^\\d{10}$" }, "firstName": { "type": "string", "title": "First name", "description": "Individual's first name.", "editor": "textfield" }, "lastName": { "type": "string", "title": "Last name", "description": "Individual's last name.", "editor": "textfield" }, "organizationName": { "type": "string", "title": "Organization name", "description": "Organization / business name (for type-2 NPIs).", "editor": "textfield" }, "state": { "type": "string", "title": "State", "description": "2-letter US state code, narrows name searches.", "editor": "textfield", "pattern": "^[A-Za-z]{2}$" }, "licenseNumber": { "type": "string", "title": "License number", "description": "State license number to compare with NPPES-reported licenses.", "editor": "textfield" }, "ref": { "type": "string", "title": "Ref", "description": "Your own id; echoed back in the result.", "editor": "textfield" }, "dob": { "type": "string", "title": "Date of birth", "description": "YYYY-MM-DD. Turns a weak name-only LEIE match into a strong name+DOB match (LEIE rows carry DOB).", "editor": "textfield" } } } }, "checkSam": { "title": "Also screen SAM.gov exclusions", "type": "boolean", "description": "When true, each provider is also screened against the SAM.gov federal exclusions list. Requires samApiKey (free key from api.data.gov). Off by default.", "default": false }, "samApiKey": { "title": "SAM.gov API key", "type": "string", "description": "Free api.data.gov key used for SAM.gov exclusion screening. Only needed when checkSam is true." }, "checkStateLicense": { "title": "Also verify license with the state board (WA, CO)", "type": "boolean", "description": "When true, a provider given with a licenseNumber and a state of WA or CO is verified directly against that state's licensing board register (Washington DOH, Colorado DORA): status, expiry and board discipline. Providers in any other state are returned unverified with a state_license_unsupported warning. Off by default.", "default": false }, "socrataAppToken": { "title": "Socrata app token (optional)", "type": "string", "description": "Optional free Socrata app token (data.wa.gov / data.colorado.gov). Not required; it raises the anonymous rate limit for large runs with checkStateLicense on." }, "maxProviders": { "title": "Max providers per run", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Safety cap on how many providers are checked (and billed) in this run.", "default": 500 } } }, "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 } } } } } } } } } }