{ "openapi": "3.0.1", "info": { "title": "ACORD 25 COI Checker: Certificate of Insurance Compliance", "description": "ACORD 25 certificate of insurance (COI) checker: reads COI PDFs (fillable, flattened or scanned) into JSON and checks limits, expiry, additional insured, waiver of subrogation, primary/non-contributory and holder. PASS/FAIL/REVIEW with reasons and per-field confidence. Rules-based, no AI.", "version": "0.1", "x-build-id": "GDzALoBpfu69tnf5x" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hanielazevedo~acord-25-coi-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hanielazevedo-acord-25-coi-checker", "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/hanielazevedo~acord-25-coi-checker/runs": { "post": { "operationId": "runs-sync-hanielazevedo-acord-25-coi-checker", "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/hanielazevedo~acord-25-coi-checker/run-sync": { "post": { "operationId": "run-sync-hanielazevedo-acord-25-coi-checker", "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": { "pdfUrls": { "title": "Certificate PDF URLs (public)", "type": "array", "description": "Public http(s) links to ACORD 25 certificate of insurance PDFs. A PDF may hold several certificates (one per page) and ACORD 101 additional-remarks pages. To use files from your Apify account, put them in a key-value store and select it below: this Actor runs with limited permissions and cannot read a store you have not selected. The prefilled public sample certificate (Cornell University) is processed free of charge.", "items": { "type": "string" } }, "pdfStore": { "title": "Certificate key-value store", "type": "string", "description": "Your Apify key-value store holding certificate PDFs (Console > Storage > Key-value stores). Selecting it grants this run read-only access to that one store. Without record keys, every record whose key ends in \".pdf\" is processed." }, "pdfKeys": { "title": "PDF record keys", "type": "array", "description": "Optional. Keys of the PDF records in the selected store, e.g. \"acme-coi-2026.pdf\". Leave empty to use every \"*.pdf\" record.", "items": { "type": "string" } }, "requirements": { "title": "Insurance requirements", "type": "object", "description": "Optional. What each certificate must meet. All keys optional; amounts in USD. Limits: glEachOccurrenceMin, glGeneralAggregateMin, glProductsCompletedOpsMin, autoCombinedSingleLimitMin, umbrellaEachOccurrenceMin, umbrellaAggregateMin, wcElEachAccidentMin, wcElDiseaseEachEmployeeMin, wcElDiseasePolicyLimitMin. Flags: additionalInsuredRequired, waiverOfSubrogationRequired, primaryNonContributoryRequired, requireWorkersCompensation, requireAutoLiability, requireGeneralLiability, requireUmbrella, allowUmbrellaToMeetLimits (default true). Lists: additionalInsuredOn (default [\"generalLiability\"]), waiverOfSubrogationOn (default [\"generalLiability\",\"workersCompensation\"]). Names/dates: certificateHolderName, insuredName, minDaysUntilExpiry, asOfDate (YYYY-MM-DD, default today UTC). Without requirements, certificates are only checked for expired policies and unreadable fields." }, "enableOcr": { "title": "OCR scanned certificates", "type": "boolean", "description": "Read image-only (scanned/photographed) certificates with the open-source Tesseract OCR engine. OCR results get lower confidence and usually a REVIEW verdict. When off, scans return SCANNED_NOT_SUPPORTED and are not charged.", "default": true }, "minFieldConfidence": { "title": "Minimum field confidence", "enum": [ "0.6", "0.7", "0.8", "0.9" ], "type": "string", "description": "Fields read below this confidence are listed in lowConfidenceFields. If a field used for a decision is below it, the verdict becomes REVIEW instead of PASS/FAIL.", "default": "0.8" }, "maxCertificates": { "title": "Max certificates per run", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Safety cap: processing stops after this many certificates.", "default": 200 }, "maxFileSizeMb": { "title": "Max file size (MB)", "minimum": 1, "maximum": 50, "type": "integer", "description": "Larger files are rejected (not charged).", "default": 20 } } }, "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 } } } } } } } } } }