21 endpoints em 1 recurso. A permissão de cada rota é a que o código exige — conferida linha a linha, não copiada do nome.
Ver a referência detalhada, com corpo de requisição e catálogo de erros →
/companiesCria pelo CNPJ (dígito verificador) ou **reconhece**: 201 na primeira, 200 nas seguintes; idempotente por externalRefCOMPANIES_WRITE/companiesLista por cursor (limit, cursor, externalRef)COMPANIES_READ/companies/resolveResolve até 100 referências (id, externalRef ou documento) de uma vez; cada item { company, error? } — referência que casa com mais de um dono devolve error.code: COMPANIES_AMBIGUOUS_SUBJECTCOMPANIES_READ/companies/ingest**Ingestão em lote**: até 100 registros, cada um com empresa, vínculos, documentos e poderes; idempotência por registro; 207COMPANIES_WRITE/companies/:idFichaCOMPANIES_READ/companies/:idAtualiza nome, externalRef e atributos, preservando a origem de cada umCOMPANIES_WRITE/companies/:id/attributesAtributos com procedência, vigente por origem e divergência derivadaCOMPANIES_READ/companies/:id/assurance?required=Nível de conhecimento por dimensão, satisfied e o que faltaCOMPANIES_READ/companies/:id/peopleVínculos, com nome resolvido **em lote** pela portaCOMPANIES_READ/companies/:id/peopleCria o vínculo (personRef, role, sharePercent, vigência); a pessoa é validada pela portaCOMPANIES_WRITE/companies/:id/people/:linkId/endEncerra o vínculo (a linha fica)COMPANIES_WRITE/companies/:id/documentsDocumentos com vigência e situaçãoCOMPANIES_READ/companies/:id/documentsAnexa (type, fileId, vigência, requestReading); mesmo arquivo = mesmo documentoCOMPANIES_WRITE/companies/:id/documents/:documentIdVeredito ou resultado de leitura (status, confidence, reading, validUntil)COMPANIES_VERIFY/companies/:id/representativesPoderesCOMPANIES_READ/companies/:id/representativesDeclara um poderCOMPANIES_WRITE/companies/:id/representatives/:representativeId/verify**Confere** contra o documento-fonteCOMPANIES_VERIFY/companies/:id/representatives/:representativeIdRevoga (a linha fica: "quem podia em 12/03?" continua respondível)COMPANIES_WRITE/companies/:id/registry/consult{ purpose }. Pergunta ao bureaus company.basic e company.ownership; grava razão social, nome fantasia, situação (registrySituation), abertura, CNAE e natureza como atributos de origem consulted (provedor, data e finalidade na linha). Devolve o QSA **sem criar vínculo** — nome e CPF mascarado (***.456.789-**; CPF inteiro do provedor é mascarado aqui) não são pessoa. partnersAvailable: false quando o provedor não entrega QSA. Provedor com ERROR ou fora: 503 COMPANIES_REGISTRY_UNAVAILABLE, nunca "não encontrado"COMPANIES_WRITE/config/settingsPorta de pessoa e política de representação vigentes (com inheritedFrom)COMPANIES_READ/config/settingsMuda a porta e/ou a política; política nova incrementa policyVersionCOMPANIES_ADMIN