Skip to main content
GET
cURL

Quando usar

Para saber o que o dossiê já tem antes de pedir de novo.

O que some por padrão

Nada é sobrescrito: a alteração contratual nova não apaga a antiga, vira a versão vigente. Por padrão some só a versão aprovada que já foi substituída por uma vigente do mesmo tipo. Documento reprovado, inconclusivo ou ainda em análise aparece sempre. Com includeHistory, vem tudo; com type, só um tipo. A lista vem em documents, e cada documento traz verdict: o veredito que vale hoje, já com a decisão do operador quando houver.
Contexto e vocabulário em Cadastro documental. Autenticação, versionamento e capacidades em Visão geral da API.

Authorizations

Authorization
string
header
required

Enter JWT token

Path Parameters

id
string
required

Id do cadastro.

Query Parameters

type
enum<string>

So os documentos deste tipo.

Available options:
CONTRATO_SOCIAL,
ALTERACAO_CONTRATUAL,
ESTATUTO_SOCIAL,
REQUERIMENTO_EMPRESARIO,
PROCURACAO_PJ,
IRPJ_ECF,
DECLARACAO_FATURAMENTO,
CERTIDAO_JUNTA,
ATA_ASSEMBLEIA,
DOC_IDENTIDADE,
COMPROVANTE_RESIDENCIA,
DIRPF,
COMPROVANTE_RENDA,
CERTIDAO_PF,
PROCURACAO_PF,
FORA_DE_ESCOPO,
NAO_IDENTIFICADO,
CERTIDAO_PGFN_PJ,
CERTIDAO_FGTS,
CADIN_FEDERAL,
CADIN_ESTADUAL,
CERTIDAO_QSA,
CERTIFICADO_SIMPLES_NACIONAL,
ESOCIAL_PJ,
COMPROVACAO_ESTADO_CIVIL,
DEMONSTRACOES_FINANCEIRAS,
EXTRATO_BANCARIO
includeHistory
boolean

true traz tambem as versoes aprovadas que ja foram substituidas por uma mais nova do mesmo tipo.

Response

Documentos com tipo, versao, status, veredito e data, dentro de documents.

documents
object[]