ZapSign API
Português
Português
  • Informações gerais
  • Como começar
  • Ambiente de testes
  • Todas as requisições prontas!
  • Autenticação
    • Token estático (Api Token)
    • JWT (recomendado)
      • Obter token de acesso
      • Atualize seu token de acesso
  • Tipos de Tokens e Como Localizá-los
  • Versionamento da API
  • Políticas de Rate Limit
  • Alerta de incidentes
  • Ambiente de produção: Como funciona o pagamento
  • Status de erros
  • Conta
    • Informações do Plano
    • Listar usuários da conta
    • Criar usuários na conta
    • Excluir usuário da conta
  • Documentos
    • Criar documento via Upload
    • OneClick (ClickWrap)
      • Criar documento (OneClick)
    • Criar documento via Modelo
    • Adicionar anexo (documento extra)
    • Adicionar anexo (documento extra) via Modelo
    • Detalhar documento
    • Listar documentos
    • Excluir documento
    • Histórico de atividades do documento
    • Opcional: Posicionar assinaturas
    • Reprovar documentos
  • Signatários
    • Detalhar signatário
    • Atualizar signatário
    • Adicionar signatário
    • Excluir signatário
    • Grupo de signatários
      • Definir grupos de signatários
      • Excluir grupos de signatários
    • Assinar em lote via API
    • Reprovar documentos pelo usuário
  • Modelos
    • Criar modelo DOCX
      • Atualizar formulario
    • Listar modelos
    • Detalhar modelo
    • Atualizar modelo
    • Excluir modelo
  • Antecedentes
    • Introdução
    • Entendendo o Resultado
    • Criar uma Consulta (Check)
      • Consulta de Pessoa
      • Consulta de Empresa
  • Consultar Check
  • Detalhe do Check
  • Parcerias
    • Atualizar status de pagamento
  • Criar conta
  • CARIMBO DE TEMPO
    • Como funciona Carimbo de Tempo?
    • Carimbo de Tempo padrão
    • Carimbo de tempo preservando a assinatura original
  • Webhooks
    • Como funcionam os Webhooks
    • Testando Webhooks
    • Criar webhook
    • Logs de Webhooks
    • Eventos
      • Documento
        • Documento criado
        • Documento removido
        • Signatário criado
      • Signatário
        • Notificação de assinatura
        • Documento visualizado
        • Confirmação de leitura
        • Documento assinado
        • Documento recusado
        • Email bounce
        • Falha na Validação
      • Antecedentes
        • Consulta concluída
    • Reprocessamento de Documentos e Webhooks
    • Deletar webhook
  • Widget
    • Como funciona o Widget
Powered by GitBook
On this page
  • Como funciona
  • Faturamento e gestão das contas associadas
  • Criar uma conta parceira
  • Response

Was this helpful?

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).

PreviousAtualizar status de pagamentoNextComo funciona Carimbo de Tempo?

Last updated 10 days ago

Was this helpful?

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)

Importante: Apenas contas com essa funcionalidade ativa poderão utilizar este endpoint. Caso você ainda não tenha acesso,

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.

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.

{
    "email": "email@email",
    "phone_number": "11111111111",
    "phone_country": "55",
    "country": "br",
    "lang": "pt-br",
    "company_name": "Nome do cliente"
}

Response

{
    "id": 543,
    "name": "Nome do cliente",
    "api_token": "010234xx-23ed-44ab-8b57-9XXXXe03cc5e-cc71-4911-bf29-3bxxxx140540",
    "created_at": "2025-04-04T22:35:16.821400Z",
    "credits_balance": 0,
    "lang": "pt-br",
    "timezone": "America/Brasilia"
}
{
    "message": "Invalid Input",
    "data": {
        "email": [
            "Este campo é obrigatório."
        ],
        "country": [
            "Este campo é obrigatório."
        ],
        "lang": [
            "Este campo é obrigatório."
        ],
        "company_name": [
            "Este campo é obrigatório."
        ]
    }
}
{
    "detail": "Você não tem permissão para executar essa ação."
}
{
    "detail": "Plan necesario para crear empresa parceira."
}
{
    "detail": "Ação não permitida para empresa parceira."
}

Na resposta da requisição, você receberá o API token exclusivo da nova conta criada. Isso permite que cada conta tenha sua própria integração com a API da ZapSign, de forma totalmente independente das demais.

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

entre em contato com o time comercial.
Atualizar status de pagamento