v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB

CLIENTES

CONSULTAR CLIENTE

API de Consulta de Cliente

A API de consultar cliente é utilizada para validar se um cliente já existe na Vindi.

Observações importantes:

Existem dois parâmetros de busca possíveis:
- email
- cpf
Não é possível utilizar os dois parâmetros simultaneamente.
Não é possível consultar clientes pelo CNPJ.
A API não retorna uma lista de clientes, sempre retorna apenas o cliente correspondente ao parâmetro informado.
O parâmetro "type_response": "J" faz com que o retorno seja em JSON. Caso não seja enviado, o retorno será em XML.

post/v1/people/get_person_by_cpf_and_email

Request body

emailstring

type_responsestring

Example request

{
  "email": "contato@pratiqueasimpatia.com.br",
  "type_response": "J"
}

Response

RETURN - CONSULTA DE CLIENTES

Example response

{
  "data_response": {
    "cpf": "429.XXX.X08-XX",
    "email": "contato@pratiqueasimpatia.com.br",
    "has_card": true,
    "name": "Victor Agostinelli Peres"
  },
  "message_response": {
    "message": "success"
  }
}