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"

Regras:

  • Padrões quando omitidos: recive_email = 2 e recive_whatsapp = 1.
  • cert_file como arquivo exige multipart/form-data; o editor desta página não suporta esse formato.
  • Se o e-mail já existe em outra empresa, o usuário existente é apenas vinculado à sua empresa como cliente; nome, senha e certificado enviados são ignorados.
  • Sem password, o cliente recebe por e-mail uma senha gerada pela plataforma; com password, nenhum e-mail é enviado.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Primeiro nome do cliente adicionado na plataforma.

string
required

Sobrenome do cliente adicionado na plataforma.

date

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

string
required

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

string
required

Telefone com DDD e 9 (ex.: 11999999999). Usado para WhatsApp quando habilitado.

string
required

Endereço do seu cliente adicionado na plataforma.

integer
enum
Defaults to 2

Recebimento de e-mails: 0 = não recebe nada, 1 = recebe tudo, 2 = recebe somente solicitações. Padrão: 2.

Allowed:
integer
enum
Defaults to 1

Recebimento de mensagens de WhatsApp: 0 = não recebe nada, 1 = recebe tudo, 2 = recebe somente solicitações. Padrão: 1.

Allowed:
string

CPF válido, formatado ou apenas números.

string

Senha de acesso do cliente. Se omitida, a plataforma gera uma senha e envia por e-mail; se informada, nenhum e-mail é enviado.

file

Arquivo do certificado digital (.pfx ou .p12). Enviar como arquivo em multipart/form-data; cert_password é obrigatória junto.

string

Senha do certificado. Obrigatória quando cert_file é enviado; senha errada responde 401.

string

Assinatura do customer em base64. Envie o conteúdo base64 puro ou uma data URI, como data:image/png;base64,.... O conteúdo precisa decodificar para uma imagem válida e ter até 5 MB. Se omitida na criação, a API tenta gerar uma assinatura padrão com o nome do customer.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json