{ "openapi": "3.0.1", "info": { "title": "Financial Adviser Register New Zealand — FSPR Check", "description": "Look up a person or firm on New Zealand's Financial Service Providers Register: which categories of financial service they are registered for, split into current and previous, licence status where recorded, and the dispute resolution scheme covering them.", "version": "0.0", "x-build-id": "nb1ZhIrLiWkXbHpEj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/malekh~financial-adviser-register-new-zealand-fspr/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-malekh-financial-adviser-register-new-zealand-fspr", "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~financial-adviser-register-new-zealand-fspr/runs": { "post": { "operationId": "runs-sync-malekh-financial-adviser-register-new-zealand-fspr", "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~financial-adviser-register-new-zealand-fspr/run-sync": { "post": { "operationId": "run-sync-malekh-financial-adviser-register-new-zealand-fspr", "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": [ "names" ], "properties": { "names": { "title": "People and firms to look up", "type": "array", "description": "Each entry is a name as a string, or an object with `name` (or firstName + lastName, or organisationName). Any extra fields, such as your own referenceId, are echoed back with the result so it reconciles with your ATS, CRM or onboarding system. Up to 200 names per run. Note: the register stores one name string per provider, so if you supply firstName + lastName the SURNAME is searched — sending 'First Last' would miss a record filed as 'Last, First'." }, "searchOperator": { "title": "How to match the name", "enum": [ "Contains", "StartsWith", "Equals" ], "type": "string", "description": "Contains is the register's own default and gives the widest recall — it is what you want for screening. Equals matches only an exact registered name, which is useful when you already hold the provider's registered name and want a single row back.", "default": "Contains" }, "includeFinancialServices": { "title": "Read each match's financial services and dispute resolution scheme", "type": "boolean", "description": "On by default, and it is the reason to use this Actor: it opens each match and reads the CATEGORIES of financial service the provider is registered for, whether each is current or previous, the licence status and licensing authority where recorded, and the dispute resolution scheme covering them. Turn it off for a fast name-and-status-only sweep across many names.", "default": true }, "maxDetailedMatches": { "title": "Matches to open per name", "minimum": 0, "maximum": 50, "type": "integer", "description": "How many matches per name to open and read in full. Matches beyond this limit are still returned with name, FSP number, registration status and dates — they are simply not expanded. Raise it if you are searching a common surname and need every match detailed.", "default": 10 } } }, "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 } } } } } } } } } }