{
"openapi": "3.0.1",
"info": {
"title": "Costa Rica Cedula Scraper — Hacienda Company Registry & KYB",
"description": "Scrape Costa Rica's official Hacienda taxpayer registry by cedula juridica or fisica. Get legal name, registration status, legal form, tax regime, tax office and all economic activities - plus the authority's own moroso (tax debt) and omiso (non-filer) flags. No API key. JSON, CSV, Excel.",
"version": "0.0",
"x-build-id": "zRsNSwdfcJajHUgIZ"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/registralia~costa-rica-cedula-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-registralia-costa-rica-cedula-scraper",
"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/registralia~costa-rica-cedula-scraper/runs": {
"post": {
"operationId": "runs-sync-registralia-costa-rica-cedula-scraper",
"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/registralia~costa-rica-cedula-scraper/run-sync": {
"post": {
"operationId": "run-sync-registralia-costa-rica-cedula-scraper",
"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": [
"identifications"
],
"properties": {
"identifications": {
"title": "Identification numbers",
"type": "array",
"description": "Costa Rican identification numbers: 9 digits for a cédula física (person), 10 digits starting with 3 for a cédula jurídica (company), 10 starting with 5 for a NITE, or 11-12 digits for a DIMEX. Dashes and spaces are ignored, so 3-101-005212 works too.",
"items": {
"type": "string"
}
},
"includeRaw": {
"title": "Include raw registry payload",
"type": "boolean",
"description": "Attach the untouched Spanish-language response from Hacienda under a `raw` field, for auditing or for fields this Actor does not map.",
"default": false
},
"checkCcssDebtorList": {
"title": "Check the CCSS list of largest social-security debtors",
"type": "boolean",
"description": "Loads the CCSS report Patronos más Morosos once per run — the ten largest debtors per economic sector, 174 employers in total, published under art. 74 of the CCSS act — and adds onCcssTopDebtorList, ccssDebtCrc, the economic sector and the collection status to every record. Adds roughly 10–20 seconds to the run.",
"default": true
},
"ccssProxyCountry": {
"title": "CCSS proxy country",
"type": "string",
"description": "The CCSS service answers Costa Rican IPs only — from anywhere else it resets the connection. The list is therefore fetched through an Apify residential proxy in this country. Leave empty to connect directly (cheaper, but only works if the Actor's own IP is accepted).",
"default": "CR"
},
"maxConcurrency": {
"title": "Parallel lookups",
"minimum": 1,
"maximum": 10,
"type": "integer",
"description": "How many identification numbers to look up at the same time. Capped at 10 — Hacienda runs a public service, so stay polite.",
"default": 5
},
"requestTimeoutSecs": {
"title": "Request timeout",
"minimum": 5,
"maximum": 120,
"type": "integer",
"description": "Seconds to wait for a single Hacienda response before giving up on it.",
"default": 30
},
"maxRetries": {
"title": "Retries",
"minimum": 0,
"maximum": 8,
"type": "integer",
"description": "How often to retry a request that was rate-limited or answered with a server error. Backoff is exponential.",
"default": 3
},
"proxyConfiguration": {
"title": "Proxy",
"type": "object",
"description": "Only needed if Hacienda rate-limits the datacenter IP. Leave it off unless you see retries in the log.",
"default": {
"useApifyProxy": 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
},
"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
}
}
}
}
}
}
}
}
}
}