Guides
Guides
Start typing to search…

Users

Overview

The Users endpoints allow you to create, update, and retrieve user accounts.

Authentication requirements differ by operation:

  • Create User requires client_id and client_secret
  • Update User and Get User require a valid access_token

When a user is created, an api_key is returned. This key is user-specific and must be securely stored if you intend to generate access tokens and manage documents on behalf of that user.

Create User

Creates a new user and returns the user’s api_key.

Important: The returned api_key must be stored securely on your server. It is required to generate access tokens for that user.

Endpoint

POST /v1/users

Request Headers

Content-Type: application/json
Cache-Control: no-cache

Request Body Example

{
  "client_id": "<client_id>",
  "client_secret": "<client_secret>",
  "user": {
    "name": "Joe",
    "last_name": "Soap",
    "email_address": "[email protected]",
    "mobile_number": ""
  }
}

Response Example

{
  "status": { "status_code": 200 },
  "data": {
    "user": {
      "key": "[user_key]",
      "name": "Joe",
      "last_name": "Soap",
      "email_address": "[email protected]",
      "mobile_number": "",
      "api_key": "[user_api_key]",
      "date_updated": 1400960715175
    }
  }
}

Example cURL

curl -X POST https://sandboxapi.quicklysign.com/v1/users \
  -H "Content-Type: application/json" \
  -H "Cache-Control: no-cache" \
  -d '{
    "client_id":"<client_id>",
    "client_secret":"<client_secret>",
    "user":{
      "name":"Joe",
      "last_name":"Soap",
      "email_address":"[email protected]",
      "mobile_number":""
    }
  }'

Update User

Updates the current authenticated user.

Note: The email address cannot be updated.

Endpoint

PUT /v1/users/self

Request Headers

Content-Type: application/json
Cache-Control: no-cache
access_token: <your_access_token>

Request Body Example

{
  "name": "Joe",
  "last_name": "Soap123",
  "mobile_number": ""
}

Response Example

{
  "status": { "status_code": 200 },
  "data": {
    "user": {
      "key": "[user_key]",
      "name": "Joe",
      "last_name": "Soap123",
      "mobile_number": "",
      "email_address": "[email protected]",
      "date_updated": 1400961473637
    }
  }
}

Example cURL

curl -X PUT https://sandboxapi.quicklysign.com/v1/users/self \
  -H "Content-Type: application/json" \
  -H "Cache-Control: no-cache" \
  -H "access_token: <your_access_token>" \
  -d '{
    "name": "Joe",
    "last_name": "Soap123",
    "mobile_number": ""
  }'

Get User

Retrieves the current authenticated user’s information.

Endpoint

GET /v1/users/self

Request Headers

Content-Type: application/json
Cache-Control: no-cache
access_token: <your_access_token>

Response Example

{
  "status": { "status_code": 200 },
  "data": {
    "user": {
      "key": "[user_key]",
      "name": "Joe",
      "last_name": "Soap123",
      "mobile_number": "",
      "email_address": "[email protected]",
      "date_updated": 1400962700213
    }
  }
}

Example cURL

curl -X GET https://sandboxapi.quicklysign.com/v1/users/self \
  -H "Content-Type: application/json" \
  -H "Cache-Control: no-cache" \
  -H "access_token: <your_access_token>"

FAQ

1. Why do I get “You do not have permission to create users” when calling /v1/users?

This occurs when the client_id and client_secret being used do not have permission to create users via the API.

To resolve this:

  • Confirm you are using the correct API credentials.
  • Ensure the credentials belong to the correct environment.
  • Contact [email protected] to request permission updates if required.

Updated 16 days ago