v1

latestOpenAPI 3.1.02026-08-041060342.7 KB

POST Create customer

Com a criação de clientes é possível disponibilizar contas no ambiente visual para que os clientes da empresa assinem documentos logados e tenham acesso rápido aos seus documentos. As contas para clientes são do modo "Read only", portanto não podem visualizar informações, criar pastas, enviar documentos nem fazer nenhuma ação no sistema além de assinar documentos para os quais recebeu uma solicitação de assinatura. As principais vantagens para se criar uma conta de cliente são: 1. Na solicitação de assinatura pelo front-end, você não precisará digitar os e-mails, basta selecionar na lista de clientes. 2. Seu cliente não vai precisar procurar no e-mail links de documentos antigos que assinou, acessando a plataforma vai ver todos na pasta "Compartilhados comigo". 3. Seu cliente não vai precisar criar a sua assinatura sempre que for assinar um documento, ele vai poder assinar logado com apenas 2 cliques. Atenção! A criação de conta NÃO É OBRIGATÓRIA para assinar documentos, é possível solicitar assinaturas apenas pelo e-mail, a conta é um recurso que busca facilitar o dia a dia de clientes que assinam muitos documentos, portanto não é algo mandatório Os clientes ou "Customers" são os clientes da empresa que envia os documentos, para criar subcontas empresariais em implantações para terceiros verifique os endpoints "Companies"

post/api/customers

Request body

namestring required

Primeiro nome do cliente adicionado na plataforma.

last_namestring required

Sobrenome do cliente adicionado na plataforma.

birthstring date

Data de nascimento do cliente no formato ano-mês-dia. Exemplo: 1990-05-12.

emailstring required

Endereço de e-mail do cliente adicionado na plataforma.

phonestring required

Número de telefone com o 9 do cliente, caso seja um WhatsApp, o mesmo será utilizado para envio de alertas e notificações, incluindo quando uma assinatura for solicitada ao mesmo.

addressstring required

Endereço do seu cliente adicionado na plataforma.

recive_emailstring

Se o usuário vai receber e-mails do sistema, 0 = Não recebe nada, 1 = Recebe tudo, 2 = Recebe somente solicitações.

recive_whatsappstring

Se o usuário vai receber mensagens de WhatsApp do sistema, 0 = Não recebe nada, 1 = Recebe tudo, 2 = Recebe somente solicitações.

cpfstring

CPF do cliente devidamente formatado ou apenas números.

passwordstring

Senha do seu colaborador para cadastro, caso não seja fornecida o sistema irá gerar uma senha temporária e enviará para ele por e-mail, caso passe uma senha, o sistema não vai avisa-lo sobre a criação da conta e não vai enviar alertas para o mesmo.

cert_filestring binary

Arquivo do certificado digital PFX.

cert_passwordstring

Senha do certificado para validação, caso passe o certificado a senha é obrigatória.

Response

200

messagestring

Mensagem de confirmação retornada pela API.

Example response

{
  "data": {
    "id": 289,
    "name": "Joaquim",
    "last_name": "Silva",
    "phone": "11999999999",
    "address": "Rua Nove de Julho, 1234, Centro, São Paulo",
    "email": "joaquim@teste.com.br"
  },
  "message": "Cliente cadastrado com sucesso!"
}