{"openapi":"3.1.0","info":{"title":"API CNPJ","description":"Base aberta do CNPJ da Receita Federal, com regime tributário.","version":"1.0"},"paths":{"/v1/meta":{"get":{"summary":"Meta","operationId":"meta_v1_meta_get","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/cnpj/{cnpj}":{"get":{"summary":"Consultar","operationId":"consultar_v1_cnpj__cnpj__get","parameters":[{"name":"cnpj","in":"path","required":true,"schema":{"type":"string","title":"Cnpj"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/cnpj/{cnpj}/regime":{"get":{"summary":"Regime","operationId":"regime_v1_cnpj__cnpj__regime_get","parameters":[{"name":"cnpj","in":"path","required":true,"schema":{"type":"string","title":"Cnpj"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/cnpj/{cnpj}/socios":{"get":{"summary":"Socios","operationId":"socios_v1_cnpj__cnpj__socios_get","parameters":[{"name":"cnpj","in":"path","required":true,"schema":{"type":"string","title":"Cnpj"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/busca":{"get":{"summary":"Busca","operationId":"busca_v1_busca_get","parameters":[{"name":"uf","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^[A-Za-z]{2}$"},{"type":"null"}],"title":"Uf"}},{"name":"municipio","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}$"},{"type":"null"}],"description":"código da Receita","title":"Municipio"},"description":"código da Receita"},{"name":"cep","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^\\d{2,5}-?\\d{0,3}$"},{"type":"null"}],"description":"CEP ou começo do CEP","title":"Cep"},"description":"CEP ou começo do CEP"},{"name":"bairro","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":3,"maxLength":60},{"type":"null"}],"title":"Bairro"}},{"name":"nome","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":3,"maxLength":80},{"type":"null"}],"description":"razão social ou nome fantasia","title":"Nome"},"description":"razão social ou nome fantasia"},{"name":"cnae","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^\\d{7}$"},{"type":"null"}],"title":"Cnae"}},{"name":"cnae_secundaria","in":"query","required":false,"schema":{"type":"boolean","description":"inclui quem tem o CNAE como secundária","default":false,"title":"Cnae Secundaria"},"description":"inclui quem tem o CNAE como secundária"},{"name":"natureza","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}$"},{"type":"null"}],"title":"Natureza"}},{"name":"situacao","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^\\d{2}(,\\d{2})*$"},{"type":"null"}],"description":"uma ou mais, com vírgula","title":"Situacao"},"description":"uma ou mais, com vírgula"},{"name":"porte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^\\d{2}$"},{"type":"null"}],"title":"Porte"}},{"name":"mei","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Mei"}},{"name":"simples","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Simples"}},{"name":"matriz","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"true só matriz, false só filial","title":"Matriz"},"description":"true só matriz, false só filial"},{"name":"aberta_desde","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Aberta Desde"}},{"name":"aberta_ate","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Aberta Ate"}},{"name":"capital_min","in":"query","required":false,"schema":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Capital Min"}},{"name":"capital_max","in":"query","required":false,"schema":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Capital Max"}},{"name":"ddd","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^\\d{2}$"},{"type":"null"}],"title":"Ddd"}},{"name":"com_telefone","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Com Telefone"}},{"name":"telefone","in":"query","required":false,"schema":{"anyOf":[{"enum":["fixo","celular"],"type":"string"},{"type":"null"}],"description":"somente fixo ou somente celular","title":"Telefone"},"description":"somente fixo ou somente celular"},{"name":"com_email","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Com Email"}},{"name":"pagina","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Pagina"}},{"name":"limite","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limite"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dominios/cnaes":{"get":{"summary":"Cnaes","operationId":"cnaes_v1_dominios_cnaes_get","parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}],"title":"Q"}},{"name":"limite","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":20,"title":"Limite"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dominios/naturezas":{"get":{"summary":"Naturezas","operationId":"naturezas_v1_dominios_naturezas_get","parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}],"title":"Q"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dominios/municipios":{"get":{"summary":"Municipios","operationId":"municipios_v1_dominios_municipios_get","parameters":[{"name":"uf","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^[A-Za-z]{2}$"},{"type":"null"}],"title":"Uf"}},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}],"title":"Q"}},{"name":"limite","in":"query","required":false,"schema":{"type":"integer","maximum":6000,"minimum":1,"default":1000,"title":"Limite"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/cnpj/{cnpj}/processos":{"get":{"summary":"Processos Do Cnpj","operationId":"processos_do_cnpj_v1_cnpj__cnpj__processos_get","parameters":[{"name":"cnpj","in":"path","required":true,"schema":{"type":"string","title":"Cnpj"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/processos/busca":{"post":{"summary":"Buscar Processos","operationId":"buscar_processos_v1_processos_busca_post","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuscaProcessos"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"BuscaProcessos":{"properties":{"cnpj":{"anyOf":[{"type":"string","maxLength":20},{"type":"null"}],"title":"Cnpj"},"cpf":{"anyOf":[{"type":"string","maxLength":20},{"type":"null"}],"title":"Cpf"},"nome":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Nome"}},"type":"object","title":"BuscaProcessos","description":"Exatamente um dos três. No corpo, para o CPF não ficar em URL nem em log de acesso."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}