{ "openapi": "3.0.3", "info": { "title": "Brazilian CNPJ Bulk Lookup & Partner Records Scraper (server mode)", "version": "1.1", "description": "Send one lookup and get the results back in the response. It takes the same input as a normal run: query parameters with GET, or a JSON body with POST. At most 20 results and 240 seconds per request; start a normal run for bigger jobs. Requests run in your own Apify account at the Actor's normal price.", "x-oa-server-mode": "1.1" }, "paths": { "/": { "get": { "operationId": "lookupGet", "summary": "Run one lookup (query parameters)", "parameters": [ { "name": "mode", "in": "query", "required": false, "description": "Look up a list of CNPJs, or discover companies that match filters.", "schema": { "type": "string", "enum": [ "lookup", "discovery" ], "default": "lookup" }, "example": "lookup" }, { "name": "cnpjs", "in": "query", "required": false, "description": "CNPJ numbers to look up (mode=lookup). Numeric or alphanumeric, formatted or plain. Example: [\"18.236.120/0001-58\", \"00000000E08G12\"]. (GET: repeat the parameter once per value.)", "schema": { "type": "array", "items": { "type": "string" }, "maxItems": 10 }, "style": "form", "explode": true, "example": [ "18236120000158" ] }, { "name": "cnpjText", "in": "query", "required": false, "description": "Paste a CSV or any text containing CNPJs (mode=lookup). Every valid CNPJ is extracted, validated and deduplicated. A spreadsheet column with or without a header works.", "schema": { "type": "string" } }, { "name": "cnaes", "in": "query", "required": false, "description": "One or more 7-digit CNAE codes (mode=discovery). Matches primary or secondary activity. Example: [\"6209100\", \"6201501\"]. (GET: repeat the parameter once per value.)", "schema": { "type": "array", "items": { "type": "string" }, "maxItems": 5 }, "style": "form", "explode": true }, { "name": "uf", "in": "query", "required": false, "description": "Brazilian state to narrow discovery (mode=discovery).", "schema": { "type": "string", "enum": [ "ALL", "AC", "AL", "AP", "AM", "BA", "CE", "DF", "ES", "GO", "MA", "MT", "MS", "MG", "PA", "PB", "PR", "PE", "PI", "RJ", "RN", "RS", "RO", "RR", "SC", "SP", "SE", "TO" ], "default": "ALL" } }, { "name": "municipio", "in": "query", "required": false, "description": "IBGE or SIAFI municipality code, digits only (mode=discovery). Example: 3550308 (São Paulo), 5300108 (Brasília). This is a code, not a city name.", "schema": { "type": "string" } }, { "name": "naturezaJuridica", "in": "query", "required": false, "description": "4-digit legal-nature code (mode=discovery). Example: 2135 (Empresário Individual), 2062 (Sociedade Empresária Limitada).", "schema": { "type": "string" } }, { "name": "partnerCpf", "in": "query", "required": false, "description": "Masked partner document from the QSA (mode=discovery), in the Receita format such as ***123456**. Add a state or CNAE to narrow the search; the same mask can match different people.", "schema": { "type": "string" } }, { "name": "situacao", "in": "query", "required": false, "description": "Keep only companies with this registration status (mode=discovery).", "schema": { "type": "string", "enum": [ "all", "ATIVA", "SUSPENSA", "INAPTA", "BAIXADA", "NULA" ], "default": "ATIVA" } }, { "name": "includePartners", "in": "query", "required": false, "description": "Include the full partner/shareholder list.", "schema": { "type": "boolean", "default": true } }, { "name": "includeSecondaryActivities", "in": "query", "required": false, "description": "Include the list of secondary CNAE activities.", "schema": { "type": "boolean", "default": true } }, { "name": "maxItems", "in": "query", "required": false, "description": "Maximum CNPJs to process in lookup, or maximum records to emit in discovery.", "schema": { "type": "integer", "default": 20, "minimum": 1, "maximum": 20 } } ], "responses": { "200": { "description": "The results as a JSON array (at most 20). They are also saved to the run's dataset and billed per result, like a normal run.", "headers": { "X-Item-Count": { "schema": { "type": "integer" }, "description": "Results returned." }, "X-Status-Message": { "schema": { "type": "string" }, "description": "The Actor's last status message, e.g. why nothing was found." } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Item" } }, "example": [ { "cnpj": "18236120000158", "cnpjFormatado": "18.236.120/0001-58", "cnpjRaiz": "18236120", "isMatriz": true, "tipoUnidade": "Matriz", "razaoSocial": "NU PAGAMENTOS S.A. - INSTITUICAO DE PAGAMENTO", "situacaoCadastralCodigo": 2, "situacaoCadastral": "Ativa", "dataSituacaoCadastral": "2013-06-04", "situacaoCadastralMotivo": "SEM MOTIVO", "situacaoCadastralMotivoCodigo": 0, "naturezaJuridica": "Sociedade Anônima Fechada", "naturezaJuridicaCodigo": 2054, "capitalSocial": 10872130000, "porteCodigo": 5, "porte": "Demais", "cnaeFiscal": 6619399, "cnaeDescricao": "Outras atividades auxiliares dos serviços financeiros não especificadas anteriormente", "cnaesSecundarios": [ { "codigo": 5913800, "descricao": "Distribuição cinematográfica, de vídeo e de programas de televisão" }, { "codigo": 6204000, "descricao": "Consultoria em tecnologia da informação" }, { "codigo": 6209100, "descricao": "Suporte técnico, manutenção e outros serviços em tecnologia da informação" } ], "endereco": { "tipoLogradouro": "RUA", "logradouro": "RUA CAPOTE VALENTE", "numero": "120", "complemento": "ANDAR 01 AO 8 E 9 ANDAR CONJ 902 E 16 ANDAR", "bairro": "PINHEIROS", "municipio": "SAO PAULO", "codigoMunicipioIbge": 3550308, "uf": "SP", "cep": "05409000" }, "municipio": "SAO PAULO", "uf": "SP", "cep": "05409000", "telefone1": "1122222222", "fax": "1120390556", "regimeTributario": "LUCRO REAL", "regimeTributarioAno": 2024, "regimeTributarioHistorico": [ { "ano": 2016, "regime": "LUCRO REAL", "escrituracoes": 1 }, { "ano": 2017, "regime": "LUCRO REAL", "escrituracoes": 1 }, { "ano": 2018, "regime": "LUCRO REAL", "escrituracoes": 1 } ], "dataInicioAtividade": "2013-06-04", "companyAgeDays": 4907, "statusAgeDays": 4907, "socios": [ { "nome": "ARTHUR FERREIRA VALADAO", "documento": "***897248**", "tipo": "Pessoa Física", "qualificacao": "Diretor", "codigoQualificacao": 10, "dataEntradaSociedade": "2021-08-03", "faixaEtaria": "Entre 31 a 40 anos", "codigoFaixaEtaria": 4 }, { "nome": "BRUNO GUSMAO ROCHA", "documento": "***948396**", "tipo": "Pessoa Física", "qualificacao": "Diretor", "codigoQualificacao": 10, "dataEntradaSociedade": "2025-12-22", "faixaEtaria": "Entre 41 a 50 anos", "codigoFaixaEtaria": 5 }, { "nome": "CLAUDIO DE NARDI QUEIROZ", "documento": "***313948**", "tipo": "Pessoa Física", "qualificacao": "Diretor", "codigoQualificacao": 10, "dataEntradaSociedade": "2026-05-08", "faixaEtaria": "Entre 41 a 50 anos", "codigoFaixaEtaria": 5 } ], "recordType": "company", "source": "minhareceita", "sourceUrl": "https://minhareceita.org/18236120000158", "sourceUpdatedAt": "2026-10", "scrapedAt": "2026-11-10T15:34:40+00:00" } ] } } }, "400": { "description": "Invalid, missing or unknown input fields. Nothing ran.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": "invalid_input", "errorDescription": "mode: required" } } } }, "422": { "description": "The Actor could not complete this request (for example, nothing matches). No results were delivered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected failure. Safe to retry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The request used up its 240 s budget. The results found so far are in partialItems.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "partialItems": { "type": "array", "items": { "$ref": "#/components/schemas/Item" } } } } ] } } } } } }, "post": { "operationId": "lookupPost", "summary": "Run one lookup (JSON body)", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "lookup", "discovery" ], "default": "lookup", "description": "Look up a list of CNPJs, or discover companies that match filters." }, "cnpjs": { "type": "array", "items": { "type": "string" }, "maxItems": 10, "description": "CNPJ numbers to look up (mode=lookup). Numeric or alphanumeric, formatted or plain. Example: [\"18.236.120/0001-58\", \"00000000E08G12\"]." }, "cnpjText": { "type": "string", "description": "Paste a CSV or any text containing CNPJs (mode=lookup). Every valid CNPJ is extracted, validated and deduplicated. A spreadsheet column with or without a header works." }, "cnaes": { "type": "array", "items": { "type": "string" }, "maxItems": 5, "description": "One or more 7-digit CNAE codes (mode=discovery). Matches primary or secondary activity. Example: [\"6209100\", \"6201501\"]." }, "uf": { "type": "string", "enum": [ "ALL", "AC", "AL", "AP", "AM", "BA", "CE", "DF", "ES", "GO", "MA", "MT", "MS", "MG", "PA", "PB", "PR", "PE", "PI", "RJ", "RN", "RS", "RO", "RR", "SC", "SP", "SE", "TO" ], "default": "ALL", "description": "Brazilian state to narrow discovery (mode=discovery)." }, "municipio": { "type": "string", "description": "IBGE or SIAFI municipality code, digits only (mode=discovery). Example: 3550308 (São Paulo), 5300108 (Brasília). This is a code, not a city name." }, "naturezaJuridica": { "type": "string", "description": "4-digit legal-nature code (mode=discovery). Example: 2135 (Empresário Individual), 2062 (Sociedade Empresária Limitada)." }, "partnerCpf": { "type": "string", "description": "Masked partner document from the QSA (mode=discovery), in the Receita format such as ***123456**. Add a state or CNAE to narrow the search; the same mask can match different people." }, "situacao": { "type": "string", "enum": [ "all", "ATIVA", "SUSPENSA", "INAPTA", "BAIXADA", "NULA" ], "default": "ATIVA", "description": "Keep only companies with this registration status (mode=discovery)." }, "includePartners": { "type": "boolean", "default": true, "description": "Include the full partner/shareholder list." }, "includeSecondaryActivities": { "type": "boolean", "default": true, "description": "Include the list of secondary CNAE activities." }, "maxItems": { "type": "integer", "default": 20, "minimum": 1, "maximum": 20, "description": "Maximum CNPJs to process in lookup, or maximum records to emit in discovery." } }, "additionalProperties": false }, "example": { "mode": "lookup", "cnpjs": [ "18236120000158" ] } } } }, "responses": { "200": { "description": "The results as a JSON array (at most 20). They are also saved to the run's dataset and billed per result, like a normal run.", "headers": { "X-Item-Count": { "schema": { "type": "integer" }, "description": "Results returned." }, "X-Status-Message": { "schema": { "type": "string" }, "description": "The Actor's last status message, e.g. why nothing was found." } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Item" } }, "example": [ { "cnpj": "18236120000158", "cnpjFormatado": "18.236.120/0001-58", "cnpjRaiz": "18236120", "isMatriz": true, "tipoUnidade": "Matriz", "razaoSocial": "NU PAGAMENTOS S.A. - INSTITUICAO DE PAGAMENTO", "situacaoCadastralCodigo": 2, "situacaoCadastral": "Ativa", "dataSituacaoCadastral": "2013-06-04", "situacaoCadastralMotivo": "SEM MOTIVO", "situacaoCadastralMotivoCodigo": 0, "naturezaJuridica": "Sociedade Anônima Fechada", "naturezaJuridicaCodigo": 2054, "capitalSocial": 10872130000, "porteCodigo": 5, "porte": "Demais", "cnaeFiscal": 6619399, "cnaeDescricao": "Outras atividades auxiliares dos serviços financeiros não especificadas anteriormente", "cnaesSecundarios": [ { "codigo": 5913800, "descricao": "Distribuição cinematográfica, de vídeo e de programas de televisão" }, { "codigo": 6204000, "descricao": "Consultoria em tecnologia da informação" }, { "codigo": 6209100, "descricao": "Suporte técnico, manutenção e outros serviços em tecnologia da informação" } ], "endereco": { "tipoLogradouro": "RUA", "logradouro": "RUA CAPOTE VALENTE", "numero": "120", "complemento": "ANDAR 01 AO 8 E 9 ANDAR CONJ 902 E 16 ANDAR", "bairro": "PINHEIROS", "municipio": "SAO PAULO", "codigoMunicipioIbge": 3550308, "uf": "SP", "cep": "05409000" }, "municipio": "SAO PAULO", "uf": "SP", "cep": "05409000", "telefone1": "1122222222", "fax": "1120390556", "regimeTributario": "LUCRO REAL", "regimeTributarioAno": 2024, "regimeTributarioHistorico": [ { "ano": 2016, "regime": "LUCRO REAL", "escrituracoes": 1 }, { "ano": 2017, "regime": "LUCRO REAL", "escrituracoes": 1 }, { "ano": 2018, "regime": "LUCRO REAL", "escrituracoes": 1 } ], "dataInicioAtividade": "2013-06-04", "companyAgeDays": 4907, "statusAgeDays": 4907, "socios": [ { "nome": "ARTHUR FERREIRA VALADAO", "documento": "***897248**", "tipo": "Pessoa Física", "qualificacao": "Diretor", "codigoQualificacao": 10, "dataEntradaSociedade": "2021-08-03", "faixaEtaria": "Entre 31 a 40 anos", "codigoFaixaEtaria": 4 }, { "nome": "BRUNO GUSMAO ROCHA", "documento": "***948396**", "tipo": "Pessoa Física", "qualificacao": "Diretor", "codigoQualificacao": 10, "dataEntradaSociedade": "2025-12-22", "faixaEtaria": "Entre 41 a 50 anos", "codigoFaixaEtaria": 5 }, { "nome": "CLAUDIO DE NARDI QUEIROZ", "documento": "***313948**", "tipo": "Pessoa Física", "qualificacao": "Diretor", "codigoQualificacao": 10, "dataEntradaSociedade": "2026-05-08", "faixaEtaria": "Entre 41 a 50 anos", "codigoFaixaEtaria": 5 } ], "recordType": "company", "source": "minhareceita", "sourceUrl": "https://minhareceita.org/18236120000158", "sourceUpdatedAt": "2026-10", "scrapedAt": "2026-11-10T15:34:40+00:00" } ] } } }, "400": { "description": "Invalid, missing or unknown input fields. Nothing ran.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": "invalid_input", "errorDescription": "mode: required" } } } }, "422": { "description": "The Actor could not complete this request (for example, nothing matches). No results were delivered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected failure. Safe to retry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The request used up its 240 s budget. The results found so far are in partialItems.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "partialItems": { "type": "array", "items": { "$ref": "#/components/schemas/Item" } } } } ] } } } } } } } }, "components": { "schemas": { "Item": { "type": "object", "description": "One result, the same record a normal run saves to its dataset.", "properties": { "cnpj": { "type": "string" }, "cnpjFormatado": { "type": "string" }, "cnpjRaiz": { "type": "string" }, "isMatriz": { "type": "boolean" }, "tipoUnidade": { "type": "string" }, "razaoSocial": { "type": "string" }, "situacaoCadastralCodigo": { "type": "integer" }, "situacaoCadastral": { "type": "string" }, "dataSituacaoCadastral": { "type": "string" }, "situacaoCadastralMotivo": { "type": "string" }, "situacaoCadastralMotivoCodigo": { "type": "integer" }, "naturezaJuridica": { "type": "string" }, "naturezaJuridicaCodigo": { "type": "integer" }, "capitalSocial": { "type": "number" }, "porteCodigo": { "type": "integer" }, "porte": { "type": "string" }, "cnaeFiscal": { "type": "integer" }, "cnaeDescricao": { "type": "string" }, "cnaesSecundarios": { "type": "array", "items": { "type": "object" } }, "endereco": { "type": "object" }, "municipio": { "type": "string" }, "uf": { "type": "string" }, "cep": { "type": "string" }, "telefone1": { "type": "string" }, "fax": { "type": "string" }, "regimeTributario": { "type": "string" }, "regimeTributarioAno": { "type": "integer" }, "regimeTributarioHistorico": { "type": "array", "items": { "type": "object" } }, "dataInicioAtividade": { "type": "string" }, "companyAgeDays": { "type": "integer" }, "statusAgeDays": { "type": "integer" }, "socios": { "type": "array", "items": { "type": "object" } }, "recordType": { "type": "string" }, "source": { "type": "string" }, "sourceUrl": { "type": "string" }, "sourceUpdatedAt": { "type": "string" }, "scrapedAt": { "type": "string" } }, "example": { "cnpj": "18236120000158", "cnpjFormatado": "18.236.120/0001-58", "cnpjRaiz": "18236120", "isMatriz": true, "tipoUnidade": "Matriz", "razaoSocial": "NU PAGAMENTOS S.A. - INSTITUICAO DE PAGAMENTO", "situacaoCadastralCodigo": 2, "situacaoCadastral": "Ativa", "dataSituacaoCadastral": "2013-06-04", "situacaoCadastralMotivo": "SEM MOTIVO", "situacaoCadastralMotivoCodigo": 0, "naturezaJuridica": "Sociedade Anônima Fechada", "naturezaJuridicaCodigo": 2054, "capitalSocial": 10872130000, "porteCodigo": 5, "porte": "Demais", "cnaeFiscal": 6619399, "cnaeDescricao": "Outras atividades auxiliares dos serviços financeiros não especificadas anteriormente", "cnaesSecundarios": [ { "codigo": 5913800, "descricao": "Distribuição cinematográfica, de vídeo e de programas de televisão" }, { "codigo": 6204000, "descricao": "Consultoria em tecnologia da informação" }, { "codigo": 6209100, "descricao": "Suporte técnico, manutenção e outros serviços em tecnologia da informação" } ], "endereco": { "tipoLogradouro": "RUA", "logradouro": "RUA CAPOTE VALENTE", "numero": "120", "complemento": "ANDAR 01 AO 8 E 9 ANDAR CONJ 902 E 16 ANDAR", "bairro": "PINHEIROS", "municipio": "SAO PAULO", "codigoMunicipioIbge": 3550308, "uf": "SP", "cep": "05409000" }, "municipio": "SAO PAULO", "uf": "SP", "cep": "05409000", "telefone1": "1122222222", "fax": "1120390556", "regimeTributario": "LUCRO REAL", "regimeTributarioAno": 2024, "regimeTributarioHistorico": [ { "ano": 2016, "regime": "LUCRO REAL", "escrituracoes": 1 }, { "ano": 2017, "regime": "LUCRO REAL", "escrituracoes": 1 }, { "ano": 2018, "regime": "LUCRO REAL", "escrituracoes": 1 } ], "dataInicioAtividade": "2013-06-04", "companyAgeDays": 4907, "statusAgeDays": 4907, "socios": [ { "nome": "ARTHUR FERREIRA VALADAO", "documento": "***897248**", "tipo": "Pessoa Física", "qualificacao": "Diretor", "codigoQualificacao": 10, "dataEntradaSociedade": "2021-08-03", "faixaEtaria": "Entre 31 a 40 anos", "codigoFaixaEtaria": 4 }, { "nome": "BRUNO GUSMAO ROCHA", "documento": "***948396**", "tipo": "Pessoa Física", "qualificacao": "Diretor", "codigoQualificacao": 10, "dataEntradaSociedade": "2025-12-22", "faixaEtaria": "Entre 41 a 50 anos", "codigoFaixaEtaria": 5 }, { "nome": "CLAUDIO DE NARDI QUEIROZ", "documento": "***313948**", "tipo": "Pessoa Física", "qualificacao": "Diretor", "codigoQualificacao": 10, "dataEntradaSociedade": "2026-05-08", "faixaEtaria": "Entre 41 a 50 anos", "codigoFaixaEtaria": 5 } ], "recordType": "company", "source": "minhareceita", "sourceUrl": "https://minhareceita.org/18236120000158", "sourceUpdatedAt": "2026-10", "scrapedAt": "2026-11-10T15:34:40+00:00" } }, "Error": { "type": "object", "required": [ "error", "errorDescription" ], "properties": { "error": { "type": "string", "enum": [ "invalid_input", "request_failed", "internal_error", "timeout", "busy", "not_found", "method_not_allowed", "payload_too_large" ] }, "errorDescription": { "type": "string" } } } }, "securitySchemes": { "apifyToken": { "type": "http", "scheme": "bearer", "description": "Your Apify API token (Apify Console, Settings, API and integrations)." } } }, "servers": [ { "url": "https://dataspryva--brazilian-cnpj-bulk-lookup-and-partner-records.apify.actor" } ], "security": [ { "apifyToken": [] } ] }