POST /v1/accounts/register

{
  "id": "c64ce66b70b21c03bfd5dfa0ab14b730",
  "name": "Ted Annature",
  "email": "ted@annature.com.au",
  "number": "1300 000 000",
  "timezone": "+10:00",
  "role": "administrator",
  "active": true,
  "group_id": "a5a885caee6286a54ad7bbd4ab5400e9",
  "organisation_id": "62e9a87c6ed1444d9d228c4a0374017d",
  "created": "2019-12-17T05:30:00Z",
  "verified": "2019-12-17T05:30:00Z",
  "credentials": {
    "id": "39e2c46c5bfa88d3d7b13f569b305436",
    "key": "ae87dccad5f1f7ae43d3c0edb08d79fe"
  }
}
This endpoint is only available for use with our Partner Program. You must include a valid X-Annature-Partner header in the request.

Creates a new independent account and organisation in a single request. This is typically used by integrators or software platforms who need to provision accounts on behalf of their clients.

Upon successful creation, this endpoint returns a pair of long-lived API credentials under the credentials object. These API keys are tied to the newly created organisation and allow you to immediately begin sending envelopes or performing other actions on behalf of that organisation.

You cannot use your own Partner API key to send envelopes for a downstream organisation. Each organisation must authenticate using its own API credentials when performing actions like sending envelopes or managing templates.

By default, a verification email will be sent to the new account holder prompting them to set a password. If you’re automating this flow, you can provide a password in the request body and set skip_verification to true to mark the account as verified without sending an email.

​
Parameters

​
name
string
required

The full name of the account holder.

​
email
string
required

The email address for the account. This will be used to log in to the Annature dashboard.

Email addresses must be unique. An error will be returned if the supplied email is already associated with an existing account.

​
business
string
required

The name of the account holder’s business. This is used to establish the new organisation.

​
number
string

The account holder’s contact number.

​
timezone
string

The timezone for this account, supplied as a 6-digit UTC offset.

Timezones must be supplied as a 6-digit UTC offset. For example:

  • +10:00 → Australia/Brisbane
  • +08:00 → Australia/Perth
​
password
string

Set the account holder’s password during creation. If omitted, the user will be prompted to set a password via the verification email.

If you plan to automate verification using skip_verification, it’s strongly recommended that you capture and supply a password at the time of account creation.

​
skip_verification
boolean

Set this to true to automatically mark the account as verified and suppress the verification email.

POST /v1/accounts/register

{
  "id": "c64ce66b70b21c03bfd5dfa0ab14b730",
  "name": "Ted Annature",
  "email": "ted@annature.com.au",
  "number": "1300 000 000",
  "timezone": "+10:00",
  "role": "administrator",
  "active": true,
  "group_id": "a5a885caee6286a54ad7bbd4ab5400e9",
  "organisation_id": "62e9a87c6ed1444d9d228c4a0374017d",
  "created": "2019-12-17T05:30:00Z",
  "verified": "2019-12-17T05:30:00Z",
  "credentials": {
    "id": "39e2c46c5bfa88d3d7b13f569b305436",
    "key": "ae87dccad5f1f7ae43d3c0edb08d79fe"
  }
}