For the complete documentation index, see llms.txt. This page is also available as Markdown.

Criar conta

Este endpoint permite que você crie contas separadas para diferentes clientes ou departamentos da sua empresa, mantendo todos eles sob o controle da sua conta principal (parceira ou reseller).

Essa estrutura é ideal para parceiros que desejam gerenciar múltiplas operações dentro de uma estrutura única, mantendo:

  • Separação de documentos e usuários por conta;

  • Permissões ajustadas por equipe ou cliente;

  • Relatórios e consumo organizados por unidade;

  • Integrações independentes para cada conta (com tokens exclusivos por conta)

Como funciona

Ao fazer a requisição para este endpoint:

  1. Será criada uma nova conta (organização) dentro da ZapSign.

  2. O proprietário da conta principal (quem fez a requisição) também será o proprietário da nova conta criada. Isso garante controle total sobre as contas associadas.

  3. O e-mail informado na requisição será adicionado à nova conta com o papel de Membro. Se você não informar um e-mail na requisição, será criado apenas um usuário, que será o proprietário da conta.

    • Um membro pode visualizar todos os documentos da conta, mas não tem acesso às configurações da plataforma.

  4. Caso um e-mail seja informado, o usuário convidado receberá um e-mail da ZapSign para criar uma senha e acessar sua conta.

Faturamento e gestão das contas associadas

⚠️ Atenção: Todos os consumos das contas associadas serão de responsabilidade da conta principal (parceiro).

Isso inclui:

  • Criação de documentos;

  • Consultas de antecedentes;

  • Envio de documentos por WhatsApp;

  • Métodos de autenticação avançada como reconhecimento facial, certificado digital, etc.

A conta principal terá acesso a um painel consolidado com todos os consumos e documentos gerados pelas contas associadas.

Se for necessário suspender temporariamente o acesso de uma conta associada, você pode utilizar o endpoint Atualizar status de pagamento

Criar uma conta parceira

POST https://api.zapsign.com.br/api/v1/partner/company/

Headers

Name
Type
Description

Authorization*

string

Api token a frente do texto "Bearer".

Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

Request Body

Name
Type
Description

email

string

E-mail do novo usuário que será adicionado como membro.

country*

string

País da nova conta. Valores possíveis:br, mx, co, pe, cl

lang*

string

Idioma da nova empresa. "pt-br" (português), "es" (espanhol), "en" (inglês). Default: "pt-br"

company_name*

string

Nome da nova empresa

phone_country

string

Código do país do telefone do novo usuário.

phone_number

string

Número de telefone do novo usuário.

primary_color

string

Opcional - Cor primária da empresa (ex: código HEX ou identificador interno).

logo_url

string

Opcional - Logo da empresa em formato base64.

Response

Last updated

Was this helpful?