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
  • How it works
  • Billing and management of associated accounts
  • Create a Partner Account
  • Response

Was this helpful?

  1. Partnerships

Create Account

This endpoint allows you to create separate accounts for different clients or departments within your company, while keeping all of them under the control of your main account..

PreviousUpdate Payment StatusNextAdd timestamp

Last updated 20 days ago

Was this helpful?

This structure is ideal for partners who want to manage multiple operations within a unified system, while maintaining:

  • Separation of documents and users by account;

  • Permissions adjusted per team or client;

  • Organized reports and usage data per unit;

  • Independent integrations for each account (with unique tokens per account).

Important: Only accounts with this feature enabled will be able to use this endpoint. If you don’t have access yet,

How it works

When making a request to this endpoint:

  1. A new account (organization) will be created within ZapSign.

  2. The owner of the main account (the one making the request) will also be set as the owner of the newly created account. This ensures full control over associated accounts.

  3. The email provided in the request will be added to the new account with the Member role. If you do not provide an email in the request, only one user will be created, who will be the owner of the account.

    • A Member can view all documents in the account but does not have access to platform settings.

  4. If an email is provided, the invited user will receive an email from ZapSign to create a password and access their account.

Billing and management of associated accounts

⚠️ Note: All usage from associated accounts will be under the responsibility of the main (partner) account.

This includes:

  • Document creation;

  • Background checks;

  • Document sending via WhatsApp;

  • Advanced authentication methods (such as facial recognition, digital certificates, etc.).

The main account will have access to a consolidated dashboard displaying all usage and documents generated by associated accounts.

SIf it becomes necessary to temporarily suspend access to an associated account, you can use the Update payment status endpoint.

Create a Partner Account

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

Headers

Name
Type
Description

Authorization*

string

API token preceded by the text "Bearer". Example: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

Request Body

Name
Type
Description

email

string

Email of the new user who will be added as a member

country*

string

Country of the new account. Possible values: br, mx, co, pe, cl

lang*

string

Language of the new company. Options: "pt-br" (Portuguese), "es" (Spanish), "en" (English). Default: "pt-br"

company_name*

string

Name of the new company

phone_country

string

Country code of the new user's phone number

phone_number

string

Phone number of the new user

{
    "email": "email@email",
    "phone_number": "11111111111",
    "phone_country": "55",
    "country": "co",
    "lang": "en",
    "company_name": "client name"
}

Response

{
    "id": 549,
    "name": "client name",
    "api_token": "bc9b2a85-52e1-4f03-9119-7614def33c3d2b8c15d5-9429-4daa-8f00-bbf3e01f6345",
    "created_at": "2025-04-07T17:39:40.380615Z",
    "credits_balance": 0,
    "lang": "en",
    "timezone": "America/Bogota"
}
{
    "message": "Invalid Input",
    "data": {
        "email": [
            "This field is required."
        ],
        "country": [
            "This field is required."
        ],
        "lang": [
            "This field is required."
        ],
        "company_name": [
            "This field is required."
        ]
    }
}
{
    "detail": "Você não tem permissão para executar essa ação."
}
{
    "detail": "Plan required to create partner company."
}
{
    "detail": "Action not allowed for partner company."
}

Each account created can have its own independent integration with the ZapSign API, completely separate from the others.

please contact the sales team.