{ "openapi": "3.0.1", "info": { "title": "Canadian Registry Lookup — licence checks at the source", "description": "Checks a person against a Canadian regulator's public register at the moment you ask, and returns the answer with the timestamp of the actual query and the source URL. No stored copy is served as an answer.", "version": "1.0", "x-build-id": "xhWRP5u4g32wjV05L" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alamr~registry-lookup-canada/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alamr-registry-lookup-canada", "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/alamr~registry-lookup-canada/runs": { "post": { "operationId": "runs-sync-alamr-registry-lookup-canada", "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/alamr~registry-lookup-canada/run-sync": { "post": { "operationId": "run-sync-alamr-registry-lookup-canada", "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": { "registry": { "title": "Register", "enum": [ "reco-on", "bccohp-bc", "cpspei-pe", "cotbc-bc", "acot-ab", "bccsw-bc", "lss-sk", "mvma-mb", "nbds-nb", "acsw-ab", "cap-ab", "cdhm-mb", "cdhs-sk", "clpnm-mb", "clpnnl-nl", "clpns-ns", "cotm-mb", "cphm-mb", "cpsnb-nb", "cpsnl-nl", "cpta-ab", "cptbc-bc", "cptnb-nb", "crnm-mb", "crnnl-nl", "crns-sk", "nlchp-nl" ], "type": "string", "description": "Which regulator to ask. Run with `listRegistries` to see what each one requires.", "default": "reco-on" }, "people": { "title": "People to check", "type": "array", "description": "Each item: { \"name\": \"...\", \"licence_number\": \"...\", \"city\": \"...\" }. A licence number, when given, outranks the name." }, "name": { "title": "Single name", "type": "string", "description": "Shortcut for one check. Ignored when People is set." }, "licenceNumber": { "title": "Single licence number", "type": "string", "description": "Exact registration number. Beats the name if both are given." }, "city": { "title": "City", "type": "string", "description": "Required by RECO — its register refuses an empty city. Supply it, or the check is refused rather than guessed." }, "profession": { "title": "Profession", "enum": [ "dentist", "dental-hygienist", "dental-assistant", "dental-technician", "dental-therapist", "denturist" ], "type": "string", "description": "Required by BCCOHP: dentist, dental-hygienist, dental-assistant, dental-technician, dental-therapist, denturist.", "default": "dentist" }, "listRegistries": { "title": "List available registers instead of checking", "type": "boolean", "description": "Returns the catalogue: regulator, jurisdiction, profession and which fields that register requires.", "default": false } } }, "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 } } } } } } } } } }