Pessoa

Realizar cadastro de um novo cliente

🔒 Autenticação necessária

Esta API utiliza Bearer Token no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: POST /api/v1/cliente/autenticacao (documento e senha do cliente) ou POST /api/v1/cliente/autenticacao/sindico (síndicos). ⚠️ O token de integração das APIs v2/v3 (POST /api/v3/auth/token) não é válido para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.

Realizar cadastro de um novo cliente

post/pessoa

Request

  • Base URL
    https://integracao.cvcrm.com.br/api/v1/cliente
  • URL
    https://integracao.cvcrm.com.br/api/v1/cliente/pessoa
  • Auth
    none declared

Request body

nomestring

Nome do cliente

documento_tipostring required

Tipo do documento do cliente: cpf ou cnpj

documentostring required

Documento do cliente (com ou sem máscara)

data_nascstring

Data de nascimento do cliente (obrigatório para pessoas físicas)

telefonestring required

Telefone do cliente

celularstring

Celular do cliente

emailstring required

Email do cliente

senhastring required

Senha do cliente

confirmastring required

Confirmação da senha do cliente

recaptcha_tokenstring required
pessoa_estrangeiraboolean

Informa se o documento é internacional

Example request

{
  "nome": "Antonio Martins (teste)",
  "documento_tipo": "cpf",
  "documento": "01234567890",
  "data_nasc": "23/06/1995",
  "telefone": "(79) 1234-56789",
  "celular": "(11) 11111-1111",
  "email": "antonioc@cvcrm.com.br",
  "senha": "12345678",
  "confirma": "12345678",
  "recaptcha_token": "03AGdBq25on-WoIEMSMYPqmkFIFy8ja65osTrbVuAICd8cZocPlVpawnZjsq_X1AHUTtfsdkDsZCEmBqoYeYrnYZ50MRC30...",
  "pessoa_estrangeira": true
}

Response

Cadastro de cliente realizado com sucesso

idinteger

Id criado

sucessoboolean

Example response

{
  "id": 90,
  "sucesso": true
}

Changes

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