Skip to main content
GET
cURL

Quando usar

Antes de pedir documento ao cliente: responde “o que já temos deste CNPJ?” sem você guardar o id do cadastro.

Dois campos respondem quase tudo

kycStatus diz se libera (UP_TO_DATE) ou se pede ação (ATTENTION, EXPIRED). completenessSlots diz exatamente o que falta.
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

document
string
required

CNPJ ou CPF, com ou sem mascara.

Response

Cadastro com situacao, completude, dados basicos oficiais e as exigencias em aberto.

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>