GET /v1/accounts
GET /v1/accounts/:id
POST /v1/accounts
POST /v1/accounts/register
POST /v1/accounts/:id/verification
POST /v1/accounts/:id/deactivate
POST /v1/accounts/:id/restore
PUT /v1/accounts/:id

{
  "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"
}

The account object represents an individual user account within your Annature organisation. Every person who uses the Annature dashboard to send or manage documents will be represented by an account.

Accounts are required to create and send envelopes, and they determine both who initiated the envelope and what permissions that user has within the organisation.

When creating an envelope, you must specify the account responsible for sending it.

​
Account roles

Accounts can be assigned one of three roles, each of which defines what the user can see and do in the Annature platform. These roles give organisations the flexibility to reflect real-world business structures — such as admin teams, department-based permissions, or read-only access for oversight and compliance.

  • administrator
    This role is typically used by business owners, IT admins, or operations staff who need complete visibility and control. Administrators can view and manage all envelopes, regardless of sender; add, edit, or remove user accounts (including other administrators); and manage organisation-level settings and groups.

  • standard
    Ideal for client-facing staff like accountants, consultants, or team members who manage their own documents. Standard users can create, send, and manage envelopes from their own account; and access envelopes shared by other accounts in the same group.

  • read-only
    Suitable for roles that need visibility into document activity without the ability to create or modify anything. Read-only users can view and download envelopes sent by other accounts in their group.

​
Sharing envelopes between accounts

By default, standard accounts can only access the envelopes they personally send.

However, when accounts are assigned to a shared group, they can collaborate more easily. If an envelope is flagged as shared, it becomes visible to all members of the group.

This is useful in team-based environments — for example, when multiple accountants in a firm need to access each other’s client documents.

A standard account can still choose to send private envelopes by not marking them as shared.

administrator accounts always have access to envelopes from any standard account in the organisation, regardless of whether sharing is enabled.

​
Attributes

​
id
string

The unique identifier for the account.

​
name
string(250)

The full name of the account holder.

​
email
string(5000)

The email address associated with the account. This is used to log in to the Annature dashboard.

​
number
string(100)

The account holder’s contact number.

​
timezone
string

The timezone used for displaying dates in the dashboard and on envelopes sent by this account. This affects timestamps on envelope certificates and date fields.

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

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

The role assigned to this account. Possible values: administrator, standard (default), or read-only.

​
active
boolean

Indicates whether the account is currently active. Inactive accounts cannot log in or send envelopes.

​
group_id
string

The unique identifier of the group this account belongs to.

​
organisation_id
string

The unique identifier of the organisation this account belongs to.

​
created
datetime

The ISO 8601 timestamp for when the account was created.

​
verified
datetime

The ISO 8601 timestamp for when the account was verified. An account must be verified before it can sign in to the dashboard.

GET /v1/accounts
GET /v1/accounts/:id
POST /v1/accounts
POST /v1/accounts/register
POST /v1/accounts/:id/verification
POST /v1/accounts/:id/deactivate
POST /v1/accounts/:id/restore
PUT /v1/accounts/:id

{
  "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"
}