Skip to main content
GET
cURL

Quando usar

Para varrer a carteira por situação: quem está com pendência, quem venceu, quem está em renovação. Filtre por kycStatus (repita o parâmetro para mais de uma situação), por entityType ou com search, que casa razão social, nome fantasia ou parte do CNPJ/CPF. A página tem 20 cadastros por padrão e até 50 com take.
Valor de kycStatus fora da lista responde 400. O reportId hoje vem sempre null.
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

Query Parameters

Casa por razao social, nome fantasia ou parte do CNPJ/CPF (mascara e ignorada).

entityType
enum<string>

COMPANY (pessoa juridica) ou PERSON (pessoa fisica).

Available options:
COMPANY,
PERSON
kycStatus
enum<string>[]

Uma ou mais situacoes. Repita o parametro para varias.

Available options:
PENDING,
PROCESSING,
UP_TO_DATE,
ATTENTION,
EXPIRED,
RENEWING
skip
integer

Quantos pular. Padrao 0.

Required range: x >= 0
take
integer

Tamanho da pagina. Padrao 20, maximo 50.

Required range: 1 <= x <= 50

Response

Pagina de cadastros com situacao e completude.

items
object[]
total
integer

Total que casa o filtro, nao o tamanho da pagina.