{ "openapi": "3.0.1", "info": { "title": "UK Bankruptcy Check by Name — Individual Insolvency Register", "description": "Bulk-check names against the UK Individual Insolvency Register: undischarged bankrupts, IVAs, debt relief orders and bankruptcy restrictions. Uses date of birth to rule namesakes OUT — 'John Smith' returns 149 records — and flags current vs discharged.", "version": "0.0", "x-build-id": "NrJWkdfLiNKxXVhiB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/malekh~uk-bankruptcy-check-individual-insolvency-register/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-malekh-uk-bankruptcy-check-individual-insolvency-register", "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/malekh~uk-bankruptcy-check-individual-insolvency-register/runs": { "post": { "operationId": "runs-sync-malekh-uk-bankruptcy-check-individual-insolvency-register", "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/malekh~uk-bankruptcy-check-individual-insolvency-register/run-sync": { "post": { "operationId": "run-sync-malekh-uk-bankruptcy-check-individual-insolvency-register", "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", "required": [ "records" ], "properties": { "records": { "title": "People to check", "type": "array", "description": "One object per person: firstName + lastName (add middleName to sharpen the match), or fullName. Add dateOfBirth (YYYY-MM-DD or DD/MM/YYYY) wherever you have it — the register carries no unique identifier, so the date of birth is what separates the person you mean from a namesake, and it is the only thing that can rule a match OUT. A postcode helps too. Any extra fields, such as your own referenceId, are echoed back with the result so it reconciles with your ATS or case management system." }, "statusFilter": { "title": "Which entries to report", "enum": [ "all", "current" ], "type": "string", "description": "Every match is labelled with caseStatusClass (current / ended / unknown) either way; this only controls which ones are listed. 'All' is the default so nothing is hidden from you.", "default": "all" }, "includeCaseDetails": { "title": "Open each case page", "type": "boolean", "description": "On by default, and you almost certainly want it on. The search results list gives only name, date of birth, trading details and postcode. The insolvency TYPE (bankruptcy / IVA / debt relief order / restrictions), the court, the case number, the order date and the discharge status all live on the case page behind it — so with this off, every match comes back with caseStatusClass 'unknown'.", "default": true }, "maxCaseDetailsPerName": { "title": "Case pages per name", "minimum": 0, "maximum": 50, "type": "integer", "description": "Upper bound on how many case pages are opened for a single name, so one very common name cannot consume the whole run. Matches beyond it are still returned, just without case detail.", "default": 10 }, "maxPagesPerName": { "title": "Result pages per name", "minimum": 1, "maximum": 60, "type": "integer", "description": "The register returns 10 results per page — 'John Smith' alone returns 149 records. This caps how deep each name is read. If the cap is hit, the result is flagged searchTruncated: true and says so in its guidance rather than pretending the list was complete. Supplying full forenames is a better fix than raising this.", "default": 5 }, "fuzzyThreshold": { "title": "Fuzzy match threshold", "minimum": 0, "maximum": 1, "type": "number", "description": "0 to 1. How close a non-exact name has to be before it is reported as a possible match. Lower catches more spelling variants and produces more to review. 0.85 is a sensible default.", "default": 0.85 } } }, "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 } } } } } } } } } }