Skip to main content
POST
cURL

Quando usar

No início de uma jornada, para garantir que o dossiê daquele CNPJ ou CPF existe.
É idempotente por documento. Chamar de novo com o mesmo CNPJ devolve o cadastro que já existe, em vez de duplicar. É seguro chamar sempre.
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

Body

application/json
document
string
required

CNPJ ou CPF valido, com ou sem mascara.

name
string

Razao social ou nome. Opcional: os dados basicos oficiais sao buscados na criacao.

Response

Cadastro com id, document, entityType (COMPANY/PERSON), name, kycStatus e completeness.

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>