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
  • Criar novos usuários
  • Headers
  • Request Body
  • Request
  • Response

Was this helpful?

  1. Conta

Criar usuários na conta

Esse endpoint permite a criação de novos usuários vinculados à organização via API. Ao utilizar essa funcionalidade, é possível adicionar novos membros à organização, configurando os níveis de permissões adequadas e garantindo que todos os dados necessários, como contato, e-mail, nome e etc. sejam devidamente registrados para o novo usuário.

IMPORTANTE: Antes da criação do novo usuário ser concluída, será validado o número de usuários disponíveis dentro da organização. Caso o limite tenha sido atingido, não será possível realizar a criação do novo usuário.

O método de requisição é POST. Caso use PATCH ou PUT, não terá o efeito desejado.

Criar novos usuários

POSThttps://api.zapsign.com.br/api/v1/users/create-user

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 usuário. String de até 255 caracteres e deve ser um e-mail válido. (Campo obrigatório)

role

string

Nível de permissão do usuário dentro da organização. Valores possíveis: "member" (Membro), "admin" (Administrador), "self_docs_limited" (Acesso limitado aos próprios documentos). Default: "self_docs_limited".

first_name

string

Primeiro nome do usuário. String de até 255 caracteres.

last_name

string

Último nome do usuário. String de até 255 caracteres.

phone_country

string

Código do país do usuário. (Ex: 55).

phone_number

string

Número do telefone do usuário. (Ex: 11999999999).

O parâmetro email é obrigatório para a criação do novo usuário. Caso valor não seja fornecido no corpo da requisição, não será possível adicionar usuário à organização.

Aviso: Não é possível criar um novo usuário com permissão de 'proprietário'.

Request

{
    "email":"loremipsum@email.com",
    "role":"admin",
    "first_name":"Lorem",
    "last_name":"Ipsum",
    "phone_country":"55",
    "phone_number":"11999999999"
}

Response

{
    "message": "Usuário criado com sucesso."
}
PreviousListar usuários da contaNextExcluir usuário da conta

Last updated 1 month ago

Was this helpful?