registry

Consultar o cadastro pelo CNPJ/CPF

Busca o dossie pelo documento, sem precisar saber o id.

E a tool para responder "o que ja temos deste CNPJ?" antes de pedir documento ao cliente: a completude e a situacao dizem se falta alguma coisa.

get/v1/registry/by-document/{document}

Request

  • Base URL: https://gyra-core.gyramais.com.br
  • URL: https://gyra-core.gyramais.com.br/v1/registry/by-document/{document}
  • Auth: HTTP bearer

Path parameters

documentstring required

CNPJ ou CPF, com ou sem mascara.

Response

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

idstring
documentstring

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

entityType'COMPANY' | 'PERSON'
namestring nullable

Razao social ou nome.

tradeNamestring nullable
legalNaturestring nullable
kycStatus'PENDING' | 'PROCESSING' | 'UP_TO_DATE' | 'ATTENTION' | 'EXPIRED' | 'RENEWING'
kycRenewalDuestring date-time nullable

Quando a renovacao vence.

completenessnumber

0 a 1.

documentsCountinteger
pendingCountinteger
reportIdstring nullable

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

basicDataSyncedAtstring date-time nullable
createdAtstring date-time
updatedAtstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.