{ "openapi": "3.0.1", "info": { "title": "Australian Business Number (ABN) Lookup", "description": "Search the Australian Business Register (ABR) for any business entity by ABN, ACN, business name, or postcode.", "version": "1.6", "x-build-id": "hTh5efJkWows31ncv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ryanclinton~australia-abn-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ryanclinton-australia-abn-lookup", "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/ryanclinton~australia-abn-lookup/runs": { "post": { "operationId": "runs-sync-ryanclinton-australia-abn-lookup", "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/ryanclinton~australia-abn-lookup/run-sync": { "post": { "operationId": "run-sync-ryanclinton-australia-abn-lookup", "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": { "query": { "title": "Search Query", "type": "string", "description": "A single ABN, ACN, business name, or postcode to verify. For verifying many at once, use Bulk queries below instead.", "default": "Google" }, "queries": { "title": "Bulk queries", "maxItems": 500, "type": "array", "description": "Verify many businesses in one run. Each entry can be an ABN, ACN, business name, or postcode. When set, this overrides the single Search Query. Returns a portfolio summary with active/cancelled/GST/risk breakdowns.", "items": { "type": "string" } }, "searchType": { "title": "Search Type", "enum": [ "auto", "abn", "name", "postcode" ], "type": "string", "description": "Type of search to perform. Leave as 'auto' to auto-detect based on query.", "default": "auto" }, "stateFilter": { "title": "State Filter", "enum": [ "", "NSW", "VIC", "QLD", "WA", "SA", "TAS", "ACT", "NT" ], "type": "string", "description": "Filter results by Australian state/territory (name search only)" }, "expectedState": { "title": "Expected state (onboarding)", "enum": [ "", "NSW", "VIC", "QLD", "WA", "SA", "TAS", "ACT", "NT" ], "type": "string", "description": "Optional. For name searches, the state/territory you expect the business to be in. A match adds an 'expected-state-match' reason to whyMatched, raising confidence for supplier onboarding. Does not filter results (use State Filter for that)." }, "policyProfile": { "title": "Decision policy profile", "enum": [ "standard", "strict", "lenient" ], "type": "string", "description": "How strictly to translate the facts into a counterparty decision (APPROVE / REVIEW / ENHANCED_DUE_DILIGENCE / REJECT). 'standard' is balanced; 'strict' flags more (e.g. non-GST, lower attention threshold) for banking-grade onboarding; 'lenient' escalates less for low-risk vendor onboarding. Every decision ships with a traceable decisionPath.", "default": "standard" }, "watchlistName": { "title": "Watchlist name (change detection)", "type": "string", "description": "Optional. Name a watchlist to enable cross-run change detection. The actor stores a snapshot per ABN and, on the next run with the same watchlist name, flags each record NEW / UNCHANGED / CHANGED / ESCALATED (left active) / RESOLVED (became active). Leave blank for a one-off lookup." }, "apiGuid": { "title": "ABR API GUID", "type": "string", "description": "Your ABR API GUID key. Register free at https://abr.business.gov.au/Tools/WebServices. Required for the API to return results." }, "maxResults": { "title": "Max Results", "minimum": 1, "maximum": 200, "type": "integer", "description": "Maximum number of results to return (name/postcode search only)", "default": 25 } } }, "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 } } } } } } } } } }