ZapSign API
English
English
  • General Information
  • Getting Started
  • ZapSign Environments
  • Ready-to-use requests!
  • Authentication
    • Static token
    • JWT Authentication
      • Get access token
      • Refresh your access token
  • Types of Tokens
  • API versioning
  • Rate Limit Policies
  • Incident alerts
  • How Payment Works
  • Status Code
  • Account
    • Plan Information
    • List account users
    • Create account users
    • Delete account user
  • Documents
    • Create document via Upload
    • OneClick (ClickWrap)
      • Create document (OneClick)
    • Create document via Template
    • Add attachment (extra document)
    • Add attachment (extra document) via Template
    • Detail document
    • List documents
    • Delete document
    • Document Audit Trail
    • Optional: Place signatures
    • Reject Documents
  • Signers
    • Detail signer
    • Update signer
    • Add signer
    • Delete signer
    • Batch sign via API
    • Reject Documents by User
  • Templates
    • Create template (DOCX)
      • Configure Template Form
    • List templates
    • Get template
    • Update template
    • Delete template
  • Partnerships
    • Update Payment Status
    • Create Account
  • TIMESTAMP
    • Add timestamp
  • Background Check
  • Introduction
  • Understanding the Result
  • Creating a Background Check
    • Person Check
    • Company check
  • Retrieve a Check
  • Check details
  • Webhooks
    • How webhooks works
    • Testing webhooks on ZapSign
    • Create Webhook
    • Webhooks logs
    • Events
      • Document
        • Doc created
        • Doc deleted
        • Created signer
      • Signer
        • Signature request send
        • Document viewed
        • Reading confirmation
        • Doc signed
        • Doc refused
        • Email bounce
        • Failed Validation
      • Background check
        • Background check completed
    • Reprocessing Documents and Webhooks
    • Delete Webhook
  • Widget
    • How widget works
Powered by GitBook
On this page
  • Create new users
  • Headers
  • Request Body
  • Request
  • Response

Was this helpful?

  1. Account

Create account users

This endpoint allows the creation of new users linked to the organization via API.

By using this functionality, you can add new members to the organization, configuring the appropriate permission levels and ensuring that all necessary data, such as contact details, email, name, etc., are properly registered for the new user.

IMPORTANT: Before the creation of the new user is completed, the number of available users within the organization will be validated. If the limit has been reached, it will not be possible to create the new user.

The request method is POST. If you use PATCH or PUT it will not have the desired effect.

Create new users

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

Headers

Name
Type
Description

Authorization*

string

apiToken ahead of the "Bearer" text.

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

Request Body

Name
Type
Description

email

string

User's email. A string of up to 255 characters and must be a valid email address. (Required field)

role

string

User's permission level within the company. Possible values: "member", "admin", "self_docs_limited" (Limited access to own documents). Default: "self_docs_limited".

first_name

string

User's first name. A string of up to 255 characters.

last_name

string

User's last name. A string of up to 255 characters.

phone_country

string

User's country code. (e.g., 55).

phone_number

string

User's phone number. (e.g., 11999999999).

The email parameter is required to create the new user. If a value is not provided in the request body, it will not be possible to add the user to the organization.

Warning: It is not possible to create a new user with 'owner' permission.

Request

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

Response

{
    "message": "User created successfully."
}
PreviousList account usersNextDelete account user

Last updated 1 month ago

Was this helpful?