GET
Consultar cliente

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

documentKey
string
required

CPF ou CNPJ do cliente.

Response

Cliente encontrado.

tokenCustomer
string

Token identificador do cliente.

type
string | null

Tipo do cliente, quando disponível.

documentKey
string

CPF ou CNPJ usado como chave do cliente.

name
string | null

Nome do cliente, quando disponível.

addInformation
string | null

Informação adicional vinculada ao cliente.

active
boolean

Indica se o cliente está ativo.

imageUrl
string | null

URL de imagem vinculada ao cliente, quando disponível.