Skip to main content
GET
cURL

Quando usar

Quando você já tem o id e quer o dossiê completo.

Só o detalhe traz estes dois

completenessSlots abre a completude por exigência, dizendo qual documento cobre cada uma. signingAuthority traz quem assina pela empresa, já achatado, lido do documento societário vigente. Na listagem eles não vêm: seria uma consulta por linha.
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.

Response

Cadastro completo, com completude aberta por exigencia.

O dossie documental de um CNPJ ou CPF.

id
string
document
string

CNPJ (14) ou CPF (11), so digitos.

entityType
enum<string>
Available options:
COMPANY,
PERSON
name
string | null

Razao social ou nome.

tradeName
string | null
kycStatus
enum<string>
Available options:
PENDING,
PROCESSING,
UP_TO_DATE,
ATTENTION,
EXPIRED,
RENEWING
kycRenewalDue
string<date-time> | null

Quando a renovacao vence.

completeness
number

0 a 1.

completenessSlots
object[]

A cesta de completude aberta. So no detalhe: na listagem seria N+1.

signingAuthority
object | null

Quem pode assinar pela empresa, ja achatado (sem a tripla value/confidence/page). null quando o cadastro nao tem documento societario validado com clausula de administracao legivel. So vem no DETALHE do cadastro.

documentsCount
integer
pendingCount
integer
reportId
string | null

Reservado para o relatorio mais recente do mesmo documento. Hoje vem null.

crossDocument
object | null

Ultima conferencia cruzada entre os documentos do cadastro. null quando nunca houve o que cruzar, o que e diferente de conferido e consistente.

basicDataSyncedAt
string<date-time> | null
createdAt
string<date-time>
updatedAt
string<date-time>