### Response Example

Source: https://docs.annature.com.au/api-reference/templates/list-all-templates

This is an example of the JSON response when listing all templates.

```json
[{
  "id": "7e8f68e4c6df9395cd7ff48d69d7e2c1",
  "name": "Non disclosure agreement template",
  "shared": false,
  "envelope_name": "Non disclosure agreement",
  "envelope_message": "Lorem ipsum dolor sit amet.",
  "envelope_shared": false,
  "created": "2019-12-17T05:30:00Z",
  "account_id": "c64ce66b70b21c03bfd5dfa0ab14b730",
  "group_id": "a5a885caee6286a54ad7bbd4ab5400e9",
  "documents": [
    {
      "id": "fcad499b03c6fc222bc66208317a18c9",
      "name": "Non disclosure agreement.pdf",
      "pages": 10,
      "original": "https://annature..",
      "master": "https://annature..",
      "created": "2019-12-17T05:30:00Z"
    }
  ],
  "roles": [
    {
      "id": "fcad499b03c6fc222bc66208317a18c9",
      "name": "Client",
      "recipient_name": "Ted Annature",
      "recipient_email": "ted@annature.com.au",
      "recipient_mobile": "+61422000000",
      "recipient_type": "signer",
      "recipient_password": "password",
      "recipient_order": 1,
      "recipient_redirects": {
        "session_completed": "https://..",
        "session_declined": "https://.."
      }
    }
  ]
}]
```

--------------------------------

### Response Example

Source: https://docs.annature.com.au/api-reference/endpoints/list-all-endpoints

Example response for listing all endpoints.

```json
[
  {
    "id": "d53ec5c47bd8fa4463b0931251f7da3e",
    "url": "https://...",
    "signature": "c7bbce6f29eadcdaa6570cc07d4bec83",
    "active": true,
    "created": "2019-12-17T05:30:00Z"
  }
]
```

--------------------------------

### Request Example

Source: https://docs.annature.com.au/api-reference/templates/use-template

Example of a request to the use template API.

```json
{
  "id": "7e8f68e4c6df9395cd7ff48d69d7e2c1",
  "name": "Non disclosure agreement",
  "message": "Lorem ipsum dolor sit amet.",
  "status": "sent",
  "shared": false,
  "created": "2019-12-17T05:30:00Z",
  "sent": "2019-12-17T05:30:00Z",
  "voided": null,
  "declined": null,
  "completed": null,
  "account_id": "c64ce66b70b21c03bfd5dfa0ab14b730",
  "group_id": "a5a885caee6286a54ad7bbd4ab5400e9",
  "recipients": [
    {
      "id": "255e591c2c9fe1bc99be1ec03075b402",
      "name": "Ted Annature",
      "email": "ted@annature.com.au",
      "mobile": "+61422000000",
      "type": "signer",
      "status": "sent",
      "message": "Lorem ipsum dolor sit amet.",
      "password": false,
      "muted": false,
      "order": 1,
      "declined_reason": null,
      "created": "2019-12-17T05:30:00Z",
      "sent": "2019-12-17T05:30:00Z",
      "declined": null,
      "completed": null,
      "redirects": {
        "session_completed": "https://..",
        "session_declined": "https://.."
      }
    }
  ]
}
```

--------------------------------

### Response Example

Source: https://docs.annature.com.au/api-reference/accounts/retrieve-account

Example response for retrieving an account.

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

--------------------------------

### Response Example

Source: https://docs.annature.com.au/api-reference/accounts/list-all-accounts

An example of the JSON response when listing accounts.

```json
[
  {
    "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"
  }
]
```

--------------------------------

### Response Example

Source: https://docs.annature.com.au/api-reference/fields/list-all-fields

Example of a successful response retrieving fields for an envelope.

```json
[
  {
    "id": "5f66f4705e35d5c49d2a7af7a896b8b4",
    "recipient_id": "255e591c2c9fe1bc99be1ec03075b402",
    "type": "signature",
    "page": 1,
    "anchor": "{{signature}}",
    "x_coordinate": 150,
    "y_coordinate": 400,
    "required": true,
    "read_only": false,
    "collaborative": false,
    "value": "foo",
    "checked": false,
    "height": 30,
    "width": 100,
    "options": [],
    "font_size": 12,
    "font_type": "courier",
    "date_format": "DD/MM/YYYY",
    "created": "2019-12-17T05:30:00Z"
  }
]
```

--------------------------------

### Response Example

Source: https://docs.annature.com.au/api-reference/documents/list-all-documents

This is an example of the JSON response when listing documents.

```json
[
  {
    "id": "fcad499b03c6fc222bc66208317a18c9",
    "name": "Non disclosure agreement.pdf",
    "pages": 10,
    "original": "https://annature..",
    "master": "https://annature..",
    "created": "2019-12-17T05:30:00Z"
  }
]
```

--------------------------------

### Response Example

Source: https://docs.annature.com.au/api-reference/envelopes/list-all-envelopes

An example of the JSON response when listing envelopes.

```json
[{
  "id": "7e8f68e4c6df9395cd7ff48d69d7e2c1",
  "name": "Non disclosure agreement",
  "message": "Lorem ipsum dolor sit amet.",
  "status": "completed",
  "shared": false,
  "created": "2019-12-17T05:30:00Z",
  "sent": "2019-12-17T05:30:00Z",
  "voided": null,
  "declined": null,
  "completed": "2019-12-17T05:30:00Z",
  "account_id": "c64ce66b70b21c03bfd5dfa0ab14b730",
  "group_id": "a5a885caee6286a54ad7bbd4ab5400e9",
  "recipients": [{
    "id": "255e591c2c9fe1bc99be1ec03075b402",
    "name": "Ted Annature",
    "email": "ted@annature.com.au",
    "mobile": "+61422000000",
    "type": "signer",
    "status": "completed",
    "message": "Lorem ipsum dolor sit amet.",
    "password": true,
    "muted": false,
    "order": 1,
    "declined_reason": null,
    "created": "2019-12-17T05:30:00Z",
    "sent": "2019-12-17T05:30:00Z",
    "declined": null,
    "completed": "2019-12-17T05:30:00Z",
    "redirects": {
      "session_completed": "https://..",
      "session_declined": "https://.."
    }
  }]
}]
```

--------------------------------

### Response Example

Source: https://docs.annature.com.au/api-reference/groups/retrieve-group

Example of a successful response when retrieving group details.

```json
{
  "id": "a5a885caee6286a54ad7bbd4ab5400e9",
  "name": "Annature group",
  "business": "Annature",
  "email": "ted@annature.com.au",
  "number": "1300 000 000",
  "address": "Level 38, 71 Eagle Street, Brisbane 4000",
  "website": "www.annature.com.au",
  "logo": "https://annature..",
  "colour": "#5469d4",
  "created": "2019-12-17T05:30:00Z"
}
```

--------------------------------

### Response Example

Source: https://docs.annature.com.au/api-reference/fields/retrieve-fields

Example of a field object returned by the API.

```json
{
  "id": "5f66f4705e35d5c49d2a7af7a896b8b4",
  "recipient_id": "255e591c2c9fe1bc99be1ec03075b402",
  "type": "signature",
  "page": 1,
  "anchor": "{{signature}}",
  "x_coordinate": 150,
  "y_coordinate": 400,
  "required": true,
  "read_only": false,
  "collaborative": false,
  "value": "foo",
  "checked": false,
  "height": 30,
  "width": 100,
  "options": [],
  "font_size": 12,
  "font_type": "courier",
  "date_format": "DD/MM/YYYY",
  "created": "2019-12-17T05:30:00Z"
}
```

--------------------------------

### Endpoint

Source: https://docs.annature.com.au/api-reference/fields/list-all-fields

GET /v1/fields

```bash
GET /v1/fields
```

--------------------------------

### Request Body

Source: https://docs.annature.com.au/api-reference/templates/use-template

Example JSON body for the request.

```json
{
  "id": "7e8f68e4c6df9395cd7ff48d69d7e2c1",
  "name": "Non disclosure agreement",
  "message": "Lorem ipsum dolor sit amet.",
  "shared": false,
  "draft": false,
  "account_id": "c64ce66b70b21c03bfd5dfa0ab14b730",
  "group_id": "a5a885caee6286a54ad7bbd4ab5400e9",
  "documents": [
    {
      "replacing": "fcad499b03c6fc222bc66208317a18c9",
      "id": "0a0cd6ec2daae5e1750dabc87953f933",
      "name": "Non disclosure agreement.pdf",
      "base": "iVBORw0KGgoAAAANSUhE.."
    }
  ],
  "recipients": [
    {
      "role_id": "fcad499b03c6fc222bc66208317a18c9",
      "name": "Ted Annature",
      "email": "ted@annature.com.au",
      "mobile": "+61422000000",
      "message": "Lorem ipsum dolor sit amet.",
      "password": "password1",
      "muted": false,
      "redirects": {
        "session_completed": "https://.."

```

--------------------------------

### Response Example

Source: https://docs.annature.com.au/api-reference/groups/list-all-groups-paged

This is an example of the JSON response when listing groups with pagination.

```json
{
  "groups": [
    {
      "id": "a5a885caee6286a54ad7bbd4ab5400e9",
      "name": "Annature group",
      "business": "Annature",
      "email": "ted@annature.com.au",
      "number": "1300 000 000",
      "address": "Level 38, 71 Eagle Street, Brisbane 4000",
      "website": "www.annature.com.au",
      "logo": "https://annature..",
      "colour": "#5469d4",
      "created": "2019-12-17T05:30:00Z"
    }
  ],
  "cursor": "eyJpZCI6ImYxMjMiLCJjcmVhdGVkIjoiMjAyNS0wNy0wOVQwODozMDowMFoifQ==",
  "has_more": true
}
```

--------------------------------

### Response

Source: https://docs.annature.com.au/api-reference/accounts/get-authentication-code

Example response containing the authentication code and its expiration.

```json
{
  "code": "f07de398c9c1422291b7698f26efb3f4",
  "expiration": "2025-05-15T10:00:00Z"
}
```

--------------------------------

### Response example

Source: https://docs.annature.com.au/api-reference/groups/create-group

Example of a successful response after creating a group.

```json
{
  "id": "a5a885caee6286a54ad7bbd4ab5400e9",
  "name": "Annature group",
  "business": "Annature",
  "email": "ted@annature.com.au",
  "number": "1300 000 000",
  "address": "3 Clunies Ross Court, Eight Mile Plains, QLD, 4130",
  "website": "www.annature.com.au",
  "colour": "#5469d4",
  "logo": "https://annature..",
  "created": "2019-12-17T05:30:00Z"
}
```

--------------------------------

### Response example

Source: https://docs.annature.com.au/api-reference/groups/list-all-groups

Example of a group object.

```json
[
  {
    "id": "a5a885caee6286a54ad7bbd4ab5400e9",
    "name": "Annature group",
    "business": "Annature",
    "email": "ted@annature.com.au",
    "number": "1300 000 000",
    "address": "Level 38, 71 Eagle Street, Brisbane 4000",
    "website": "www.annature.com.au",
    "logo": "https://annature..",
    "colour": "#5469d4",
    "created": "2019-12-17T05:30:00Z"
  }
]
```

--------------------------------

### Response Example

Source: https://docs.annature.com.au/api-reference/accounts/list-all-accounts-paged

A JSON response example for the list all accounts (paged) endpoint, including account details, a pagination cursor, and a flag indicating if more results are available.

```json
{
  "accounts": [
    {
      "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"
    }
  ],
  "cursor": "eyJpZCI6ImYxMjMiLCJjcmVhdGVkIjoiMjAyNS0wNy0wOVQwODozMDowMFoifQ==",
  "has_more": true
}
```

--------------------------------

### Request Example

Source: https://docs.annature.com.au/api-reference/envelopes/create-envelope

Example of a request to create an envelope.

```json
{
    "name": "Non disclosure agreement",
    "message": "Lorem ipsum dolor sit amet.",
    "recipients": [
      {
        "name": "Ted Annature",
        "email": "ted@annature.com.au",
        "type": "signer"
      }
    ],
    "metadata": {}
  }
```

--------------------------------

### Headers

Source: https://docs.annature.com.au/api-reference/introduction

Example headers for API requests.

```json
{
  "Accept": "application/json",
  "Content-Type": "application/json"
}
```

--------------------------------

### Response Example

Source: https://docs.annature.com.au/api-reference/recipients/retrieve-signing-token

Example response when retrieving a signing token.

```json
{
  "endpoint": "https://annature..",
  "expiration": "2019-12-17T05:30:00Z"
}
```

--------------------------------

### Response Example

Source: https://docs.annature.com.au/api-reference/envelopes/create-envelope

Example of a successful response when creating an envelope.

```json
{
    "id": "7e8f68e4c6df9395cd7ff48d69d7e2c1",
    "name": "Non disclosure agreement",
    "message": "Lorem ipsum dolor sit amet.",
    "status": "sent",
    "shared": false,
    "created": "2019-12-17T05:30:00Z",
    "sent": "2019-12-17T05:30:00Z",
    "voided": null,
    "declined": null,
    "completed": null,
    "account_id": "c64ce66b70b21c03bfd5dfa0ab14b730",
    "group_id": "a5a885caee6286a54ad7bbd4ab5400e9",
    "recipients": [
      {
        "id": "255e591c2c9fe1bc99be1ec03075b402",
        "name": "Ted Annature",
        "email": "ted@annature.com.au",
        "mobile": "+61422000000",
        "type": "signer",
        "status": "sent",
        "message": "Lorem ipsum dolor sit amet.",
        "password": false,
        "sms_auth": "+61422000000",
        "muted": false,
        "order": 1,
        "declined_reason": null,
        "created": "2019-12-17T05:30:00Z",
        "sent": "2019-12-17T05:30:00Z",
        "declined": null,
        "completed": null,
        "redirects": {
          "session_completed": "https://..",
          "session_declined": "https://.."
        }
      }
    ],
    "metadata": {}
  }
```

--------------------------------

### Create Account Request

Source: https://docs.annature.com.au/api-reference/accounts/create-account

This example shows how to create a new account with a specified password and skip verification for partners.

```bash
POST /v1/accounts
```

```json
{
  "name": "Ted Annature",
  "email": "ted@annature.com.au",
  "password": "secret123",
  "number": "1300 000 000",
  "timezone": "+10:00",
  "role": "administrator",
  "group_id": "a5a885caee6286a54ad7bbd4ab5400e9",
  "skip_verification": true
}
```

--------------------------------

### Response Example

Source: https://docs.annature.com.au/api-reference/endpoints/retrieve-endpoint

This is an example of a successful response when retrieving webhook endpoint details.

```json
{
  "id": "d53ec5c47bd8fa4463b0931251f7da3e",
  "url": "https://...",
  "signature": "c7bbce6f29eadcdaa6570cc07d4bec83",
  "active": true,
  "created": "2019-12-17T05:30:00Z"
}
```

--------------------------------

### Response

Source: https://docs.annature.com.au/api-reference/endpoints/create-endpoint

Example response after successfully creating a webhook endpoint.

```json
{
  "id": "d53ec5c47bd8fa4463b0931251f7da3e",
  "url": "https://example.com/webhooks",
  "signature": "c7bbce6f29eadcdaa6570cc07d4bec83",
  "active": true,
  "created": "2019-12-17T05:30:00Z"
}
```

--------------------------------

### Webhook Headers Example

Source: https://docs.annature.com.au/api-reference/webhooks

Example of the headers included in a webhook request, specifically the X-Annature-Signature for verification.

```bash
POST / HTTP/1.1
Host: example.com

{
  "X-Annature-Signature": "da6d893b3e5b4b0592cf45432e256e85"
}
```

--------------------------------

### Endpoint

Source: https://docs.annature.com.au/api-reference/accounts/list-all-accounts

The GET endpoint to list all accounts.

```bash
GET /v1/accounts
```

--------------------------------

### Endpoints

Source: https://docs.annature.com.au/api-reference/fields/field-object

Example endpoints for retrieving field information.

```bash
GET /v1/fields
GET /v1/fields/:id
GET /v1/fields/:id/attachments
```

--------------------------------

### Response Example

Source: https://docs.annature.com.au/api-reference/fields/retrieve-attachments

Example of the JSON response when retrieving attachments.

```json
[
  {
    "id": "5f66f4705e35d5c49d2a7af7a896b8b4",
    "original": "https://annature..",
    "name": "Drivers license.png",
    "type": "image/png",
    "size": 115226,
    "created": "2019-12-17T05:30:00Z"
  }
]
```

--------------------------------

### Endpoint

Source: https://docs.annature.com.au/api-reference/groups/list-all-groups-paged

GET /v2/groups

```bash
GET /v2/groups
```

--------------------------------

### Document Object Example

Source: https://docs.annature.com.au/api-reference/documents/document-object

Example of a Document object returned by the API.

```json
{
  "id": "fcad499b03c6fc222bc66208317a18c9",
  "name": "Non disclosure agreement.pdf",
  "pages": 10,
  "original": "https://annature..",
  "master": "https://annature..",
  "created": "2019-12-17T05:30:00Z"
}
```

--------------------------------

### Create a document endpoint and request body

Source: https://docs.annature.com.au/api-reference/documents/create-document

This example shows the POST request to create a document and the structure of the request body.

```bash
POST /v1/documents
```

```json
{
  "id": "fcad499b03c6fc222bc66208317a18c9",
  "name": "Non disclosure agreement.pdf",
  "base": "iVBORw0KGgoAAAANSUhE..",
  "type": "application/pdf",
  "envelope_id": "7e8f68e4c6df9395cd7ff48d69d7e2c1"
}
```

--------------------------------

### Endpoint

Source: https://docs.annature.com.au/api-reference/accounts/list-all-accounts-paged

The GET endpoint for listing accounts with pagination.

```bash
GET /v2/accounts
```

--------------------------------

### Create Account Response

Source: https://docs.annature.com.au/api-reference/accounts/create-account

This example shows a successful response after creating a new account.

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

--------------------------------

### Response Example

Source: https://docs.annature.com.au/api-reference/envelopes/retrieve-envelope

JSON response for retrieving envelope details.

```json
{
  "id": "7e8f68e4c6df9395cd7ff48d69d7e2c1",
  "name": "Non disclosure agreement",
  "message": "Lorem ipsum dolor sit amet.",
  "status": "sent",
  "shared": false,
  "created": "2019-12-17T05:30:00Z",
  "sent": "2019-12-17T05:30:00Z",
  "voided": null,
  "declined": null,
  "completed": null,
  "master": "https://annature..",
  "certificate": "https://annature..",
  "combined": "https://annature..",
  "account_id": "c64ce66b70b21c03bfd5dfa0ab14b730",
  "group_id": "a5a885caee6286a54ad7bbd4ab5400e9",
  "recipients": [
    {
      "id": "255e591c2c9fe1bc99be1ec03075b402",
      "name": "Ted Annature",
      "email": "ted@annature.com.au",
      "mobile": "+61422000000",
      "type": "signer",
      "status": "sent",
      "message": null,
      "password": false,
      "muted": false,
      "order": 1,
      "declined_reason": null,
      "created": "2019-12-17T05:30:00Z",
      "sent": "2019-12-17T05:30:00Z",
      "declined": null,
      "completed": null,
      "redirects": {
        "session_completed": "https://..",
        "session_declined": "https://.."
      }
    }
  ],
  "metadata": {}
}
```

--------------------------------

### List all groups

Source: https://docs.annature.com.au/api-reference/groups/list-all-groups

GET /v1/groups

```bash
GET /v1/groups
```

--------------------------------

### Headers

Source: https://docs.annature.com.au/

Example headers for API requests, specifying JSON content type and acceptance.

```json
{
  "Accept": "application/json",
  "Content-Type": "application/json"
}

```

--------------------------------

### Endpoint

Source: https://docs.annature.com.au/api-reference/accounts/get-authentication-code

The endpoint to generate an authentication code.

```bash
GET /v1/accounts/:id/auth-code
```

--------------------------------

### Response Example

Source: https://docs.annature.com.au/api-reference/envelopes/list-all-envelopes-paged

A JSON response showing a paginated list of envelopes, including cursor and has_more information.

```json
{
  "envelopes": [
    {
      "id": "7e8f68e4c6df9395cd7ff48d69d7e2c1",
      "name": "Non disclosure agreement",
      "message": "Lorem ipsum dolor sit amet.",
      "status": "completed",
      "shared": false,
      "created": "2019-12-17T05:30:00Z",
      "sent": "2019-12-17T05:30:00Z",
      "voided": null,
      "declined": null,
      "completed": "2019-12-17T05:30:00Z",
      "account_id": "c64ce66b70b21c03bfd5dfa0ab14b730",
      "group_id": "a5a885caee6286a54ad7bbd4ab5400e9",
      "recipients": [
        {
          "id": "255e591c2c9fe1bc99be1ec03075b402",
          "name": "Ted Annature",
          "email": "ted@annature.com.au",
          "mobile": "+61422000000",
          "type": "signer",
          "status": "completed",
          "message": "Lorem ipsum dolor sit amet.",
          "password": true,
          "muted": false,
          "order": 1,
          "declined_reason": null,
          "created": "2019-12-17T05:30:00Z",
          "sent": "2019-12-17T05:30:00Z",
          "declined": null,
          "completed": "2019-12-17T05:30:00Z",
          "redirects": {
            "session_completed": "https://..",
            "session_declined": "https://.."
          }
        }
      ]
    }
  ],
  "cursor": "eyJpZCI6ImYxMjMiLCJjcmVhdGVkIjoiMjAyNS0wNy0wOVQwODozMDowMFoifQ==",
  "has_more": true
}
```

--------------------------------

### Create document response

Source: https://docs.annature.com.au/api-reference/documents/create-document

This example shows the JSON response after successfully creating a document.

```json
{
  "id": "fcad499b03c6fc222bc66208317a18c9",
  "name": "Non disclosure agreement.pdf",
  "pages": 3,
  "original": "https://annature..",
  "master": null,
  "created": "2025-07-23T02:00:00Z"
}
```

--------------------------------

### Organisation Object

Source: https://docs.annature.com.au/api-reference/organisations/organisation-object

This snippet shows an example of the Organisation object structure.

```json
{
  "id": "a5a885caee6286a54ad7bbd4ab5400e9",
  "name": "Annature group",
  "email": "ted@annature.com.au",
  "number": "1300 000 000",
  "address": "Level 38, 71 Eagle Street, Brisbane 4000",
  "website": "www.annature.com.au",
  "logo": "https://annature..",
  "color": "#5469d4",
  "created": "2019-12-17T05:30:00Z"
}
```

--------------------------------

### Endpoint

Source: https://docs.annature.com.au/api-reference/envelopes/list-all-envelopes-paged

The GET endpoint for listing envelopes with pagination.

```bash
GET /v2/envelopes
```

--------------------------------

### Retrieve an endpoint

Source: https://docs.annature.com.au/api-reference/endpoints/retrieve-endpoint

This example shows how to retrieve the details of a specific webhook endpoint using its ID.

```bash
GET /v1/endpoints/:id
```

--------------------------------

### Endpoint

Source: https://docs.annature.com.au/api-reference/templates/list-all-templates

This is the endpoint for listing all templates.

```bash
GET /v1/templates
```

--------------------------------

### Endpoint

Source: https://docs.annature.com.au/api-reference/templates/use-template

The POST endpoint to use a template.

```bash
POST /v1/templates/:id/use
```

--------------------------------

### Recipient Completed Event Example

Source: https://docs.annature.com.au/api-reference/events/recipient-completed

An example of the JSON payload for the recipient_completed event.

```json
{
  "event": "recipient_completed",
  "recipient_id": "255e591c2c9fe1bc99be1ec03075b402",
  "envelope_id": "7e8f68e4c6df9395cd7ff48d69d7e2c1",
  "completed": "2019-12-17T05:30:00Z"
}
```

--------------------------------

### Base URL

Source: https://docs.annature.com.au/api-reference/introduction

The base URL for all Annature API requests.

```bash
https://api.annature.com.au/
```

--------------------------------

### Response Example

Source: https://docs.annature.com.au/api-reference/recipients/resend-sms

Example of a successful response when resending a signing SMS.

```json
{
  "id": "255e591c2c9fe1bc99be1ec03075b402",
  "name": "Ted Annature",
  "email": "ted@annature.com.au",
  "mobile": "+61422000000",
  "type": "signer",
  "status": "sent",
  "message": "Lorem ipsum dolor sit amet.",
  "password": true,
  "muted": false,
  "order": 1,
  "declined_reason": "Lorem ipsum dolor sit amet.",
  "created": "2019-12-17T05:30:00Z",
  "sent": "2019-12-17T05:30:00Z",
  "declined": "2019-12-17T05:30:00Z",
  "completed": "2019-12-17T05:30:00Z",
  "redirects": {
    "session_completed": "https://..",
    "session_declined": "https://.."
  }
}
```

--------------------------------

### Retrieve Organisation Response Example

Source: https://docs.annature.com.au/api-reference/organisations/retrieve-organisation

Example JSON response for the retrieve organisation endpoint.

```json
{
  "id": "0e9e7a5b390085c6179c3839274aa350",
  "name": "Annature",
  "email": "ted@annature.com.au",
  "number": "1300 000 000",
  "address": "Level 38, 71 Eagle Street, Brisbane 4000",
  "website": "www.annature.com.au",
  "logo": "https://annature..",
  "color": "#5469d4",
  "created": "2019-12-17T05:30:00Z"
}
```

--------------------------------

### Retrieve an envelope

Source: https://docs.annature.com.au/api-reference/envelopes/retrieve-envelope

GET /v1/envelopes/:id

```bash
GET /v1/envelopes/:id
```

--------------------------------

### Register an account

Source: https://docs.annature.com.au/api-reference/accounts/register-account

Creates a new independent account and organisation in a single request.

```bash
POST /v1/accounts/register
```

```json
{
  "name": "Ted Annature",
  "email": "ted@annature.com.au",
  "business": "Annature",
  "number": "1300 000 000",
  "timezone": "+10:00",
  "password": "password1",
  "skip_verification": false
}
```

--------------------------------

### Request Headers Example

Source: https://docs.annature.com.au/api-reference/authentication

All requests to the Annature API must include the X-Annature-Id (public key) and X-Annature-Key (private key) headers.

```bash
{ 
  "X-Annature-Id": "your-public-key", 
  "X-Annature-Key": "your-private-key" 
}
```

--------------------------------

### Account Object

Source: https://docs.annature.com.au/api-reference/fields/field-object

Example JSON structure of a Field Object.

```json
{
  "id": "5f66f4705e35d5c49d2a7af7a896b8b4",
  "type": "signature",
  "page": 1,
  "anchor": "{{signature}}",
  "x_coordinate": 150,
  "y_coordinate": 400,
  "required": true,
  "read_only": false,
  "collaborative": false,
  "value": "foo",
  "checked": false,
  "height": 30,
  "width": 100,
  "options": [],
  "font_size": 12,
  "font_type": "courier",
  "date_format": "DD/MM/YYYY",
  "created": "2019-12-17T05:30:00Z"
}
```

--------------------------------

### Endpoint

Source: https://docs.annature.com.au/api-reference/endpoints/create-endpoint

The HTTP method and path for creating a new endpoint.

```bash
POST /v1/endpoints
```

--------------------------------

### Update Recipient Endpoint

Source: https://docs.annature.com.au/api-reference/recipients/update-recipient

This example shows the endpoint for updating a recipient.

```bash
PUT /v1/recipients/255e591c2c9fe1bc99be1ec03075b402
```