# API Guide

## API Documentation

This page is meant for developers, vendors, and IT administrators to understand how to generate the bearer token to access our API to create documents for signing.

### Bearer Token & API Key Generation

**Bearer authentication** (also called **token authentication**) is an HTTP **authentication** scheme that involves security **tokens** called **bearer tokens**. Signify uses bearer authentication. 

To generate the token, click on "API Integration" in the navigation bar. From there, click on `Generate API key` and copy the token. Use this key to start using Signify's API. 

<figure><img src="/files/WyHkhy42Sl9LPTHrLdwQ" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
**Keep the bearer token** **safe:** You should not share the bearer token with anyone. Use services like 1Password to store it.&#x20;
{% endhint %}

### Authentication

Signify's API uses API Key for authentication. User can view and manage API Keys in Signify API Dashboard.

Production secret keys will have `production_v1_`version prefix.

Authentication to the API is performed via bearer auth.

Sample CURL request:

```
curl -X POST "https://app.signify.gov.sg/public/v1/documents" \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: multipart/form-data' \
  -F 'documentName=Testing API' \
  -F 'recipients=[{"email":"<EMAIL_1>","requiredSignatures":[{"page":1, "positionX":0.1, "positionY":0.2}, {"page":1, "positionX":0.2, "positionY":0.3}], "customMessage": "Please sign on Page 3."},{"email":"<EMAIL_2>","requiredSignatures":[{"page":1, "positionX":0.5, "positionY":0.5}]}]' \
  -F 'file=@"<FILE_PATH>"'
```

All API requests must be made over HTTPS. Calls made over plain HTTP will fail and requests without authentication will also fail.

### Errors

Signify API uses conventional API Error to indicate the success or failure of an API request.

| Status Codes                       | Description                                                                                      |
| ---------------------------------- | ------------------------------------------------------------------------------------------------ |
| 200 - OK                           | Everything worked as expected.                                                                   |
| 400 - Bad Request                  | The request was unacceptable, often due to missing a required parameter.                         |
| 401 - Unauthorized                 | No valid API key provided.                                                                       |
| 403 - Forbidden                    | No valid API key provided.                                                                       |
| 404 - Not Found                    | The requested resource doesn't exist.                                                            |
| 429 - Too Many Requests            | Too many requests hit the API too quickly. We recommend an exponential backoff of your requests. |
| 500, 502, 503, 504 - Server Errors | Something went wrong on Signify's end.                                                           |

```json
{
  "message": "Unauthorized"
}
```

### Rate Limits

For all of Signify's APIs, Signify allows up to 100 requests per 10 seconds (subject to change).

### Endpoints

| Environment | Endpoint                                 |
| ----------- | ---------------------------------------- |
| Production  | <https://app.signify.gov.sg/public/>     |
| Staging     | <https://staging.signify.gov.sg/public/> |

### Create Document (will be deprecated from 1 December 2026)

`POST /v2/documents`

{% hint style="danger" %}
This endpoint will be deprecated from 1 December 2026. Please switch to the new [Create Document endpoint](#create-document-available-from-3-june-2026) before then.
{% endhint %}

**Content type**

The request must be of type `multipart/form-data`.

**Signing modes**

We support two modes of signing invitation: (1) signing by email and (2) signing by link.

* In signing by email, the API caller supplies the email addresses of the signatories, and an email invite is sent out by Signify to the signatories to sign the document.
* In signing by link, no email addresses are supplied by the API caller. Signing links are returned to the API caller, who can then redirect their users to the signing link.

The signing mode is specified in the `documentMode` property of the request body.

Both signing modes require the API caller to specify the location of the signature placeholders.

#### Signing by Email

The mandatory fields in request body are:

1. `documentName` - the document name
2. `recipients` - an array of `{email: string, requiredSignatures: requiredSignature[], customMessage?: string}`
3. `file` - the file binary

The optional fields in the request body are:

1. `documentMode` - For signing by email, you may specify this to be `email`. If not specified, this will default to `email`.
2. `redirectUrl` - Signify will redirect to this redirectUrl upon completion of signing (by each email receipient). Only URLs with a `https` protocol, and a `.gov.sg` domain will be accepted.

<table><thead><tr><th width="187">Property</th><th>Type</th><th width="111">Required?</th><th>Restrictions</th></tr></thead><tbody><tr><td>documentName</td><td><code>string</code></td><td>Yes</td><td><p>Must have at least 4 characters and at most 100 characters.<br><br>Only the following character set is allowed:</p><pre><code><strong>a-zA-Z0-9_\-./() &#x26;`;'"
</strong></code></pre></td></tr><tr><td>recipients</td><td>An array of <code>{email: string, requiredSignatures: requiredSignature[], customMessage?: string}</code></td><td>Yes</td><td><p>Email addresses must be unique. <br><br><code>requiredSignatures</code> is an array of the <code>requiredSignature</code> object, which has the type:</p><pre class="language-typescript"><code class="lang-typescript">{ page: number,
positionX: number,
positionY: number }
</code></pre><ul><li><code>page</code> represents the page that the fixed signature placeholder is located</li><li><code>positionX</code> and <code>positionY</code> are numbers between 0 to 1. They represent the location of the fixed signature as a percentage of the total document's width and height respectively.<br>Refer below for instructions on how to retrieve these coordinates.</li><li><code>requiredSignature</code> array has a max length of 20 per email recipient</li></ul><p></p><p><code>customMessage</code> is an optional attribute of 1 to 1000 characters. The message will be sent out as part of the email invitation to the recipient.</p></td></tr><tr><td>file</td><td><code>binary</code></td><td>Yes</td><td>Up to 10MB</td></tr><tr><td>documentMode</td><td><code>email</code> literal</td><td>No, optional</td><td></td></tr><tr><td>redirectUrl</td><td><code>string</code></td><td>No, optional</td><td>Must have a <code>https</code> protocol and a <code>.gov.sg</code> domain</td></tr></tbody></table>

How to obtain positionX and positionY:

One way to obtain `positionX` and `positionY` is to

1. Create a document via Signify web <https://signify.gov.sg/>
2. Inspect the network call to <https://app.signify.gov.sg/api/v1/documents/upload>, extract `positionX` and `positionY` from the payload
3. Use these values in your API call

Sample CURL request:

```sh
curl -X POST "https://app.signify.gov.sg/public/v2/documents" \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: multipart/form-data' \
  -F 'documentName=Testing API' \
  -F 'recipients=[{"email":"<EMAIL_1>","requiredSignatures":[{"page":1, "positionX":0.1, "positionY":0.2}, {"page":1, "positionX":0.2, "positionY":0.3}], "customMessage": "Please sign on Page 3."},{"email":"<EMAIL_2>","requiredSignatures":[{"page":1, "positionX":0.5, "positionY":0.5}]}]' \
  -F 'file=@"<FILE_PATH>"'
```

**Returns:**

```json
{
    "documentId": 20
}
```

**Explanation of fields returned:**

| Field returned | What it means                         | Example |
| -------------- | ------------------------------------- | ------- |
| `documentId`   | The unique identifier of the document | 5       |

#### Signing by Link

The mandatory fields in request body are:

1. `documentName` - the document name
2. `totalSignaturesByLink` - a length 1 array of `{requiredSignatures: requiredSignature[]}`
3. `file` - the file binary
4. `documentMode` - this must be specified as `link`

The optional fields in the request body are:

1. `redirectUrl` - Signify will redirect to this redirectUrl upon completion of signing. Only URLs with a `https` protocol, and a `.gov.sg` domain will be accepted.

<table><thead><tr><th>Property</th><th>Type</th><th>Required?</th><th>Restrictions</th></tr></thead><tbody><tr><td>documentName</td><td><code>string</code></td><td>Yes</td><td><p>Must have at least 4 characters and at most 100 characters.<br><br>Only the following character set is allowed:</p><pre><code>a-zA-Z0-9_\-./() &#x26;`;'"
</code></pre></td></tr><tr><td><code>totalSignaturesByLink</code></td><td>A length 1 array of <code>{requiredSignatures: requiredSignature[]}</code></td><td>Yes</td><td><p>Array must be of length exactly 1<br></p><p><code>requiredSignature</code> has the type </p><pre class="language-typescript"><code class="lang-typescript">{ page: number,
positionX: number,
positionY: number }
</code></pre><ul><li><code>page</code> represents the page that the fixed signature placeholder is located</li><li><code>positionX</code> and <code>positionY</code> are numbers between 0 to 1. They represent the location of the fixed signature as a percentage of the total document's width and height respectively. Refer below for instructions on how to retrieve these coordinates.</li><li><code>requiredSignature</code> array has a max length of 20</li></ul></td></tr><tr><td>file</td><td><code>binary</code></td><td>Yes</td><td>Up to 10MB</td></tr><tr><td>documentMode</td><td><code>link</code> literal</td><td>Yes</td><td></td></tr><tr><td>redirectUrl</td><td><code>string</code></td><td>No, optional</td><td>Must have a <code>https</code> protocol and a <code>.gov.sg</code> domain</td></tr></tbody></table>

How to obtain positionX and positionY:

One way to obtain `positionX` and `positionY` is to

1. Create a document via Signify web <https://signify.gov.sg/>
2. Inspect the network call to <https://app.signify.gov.sg/api/v1/documents/upload-link>, extract `positionX` and `positionY` from the payload
3. Use these values in your API call

Sample CURL request:

```sh
curl -X POST "https://app.signify.gov.sg/public/v2/documents" \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: multipart/form-data' \
  -F 'documentName="Document 1"' \
  -F 'totalSignaturesByLink="[{"requiredSignatures": [{"page": 1, "positionX": 0, "positionY": 0}, {"page": 2, "positionX": 0.2, "positionY": 0.3}]} \
  -F 'documentMode="link"' \
  -F 'file=@"<FILE_PATH>"'

```

**Returns:**

```json
{
    "documentId": "3",
    "signingLinks": [
        {
            "signingLink": "https://app.signify.gov.sg/documents/sign/01hfk78xjafvn9n8xn084a9rsn",
            "totalSignatures": 2
        }
    ]
}
```

**Explanation of fields returned:**

<table><thead><tr><th>Field returned</th><th>What it means</th><th>Example</th></tr></thead><tbody><tr><td><code>documentId</code></td><td>The unique identifier of the document</td><td>3</td></tr><tr><td><code>signingLinks</code></td><td>The signing links for this document, in an array.<br><br>For each link, <code>signingLink</code> is the link URL, and <code>totalSignatures</code> is the number of signatures required for that link, as specified during document creation. </td><td><pre><code>[
    {
        "signingLink": "https://app.signify.gov.sg/documents/sign/01hfk78xjafvn9n8xn084a9rsn",
        "totalSignatures": 3
    }
]
</code></pre></td></tr></tbody></table>

### Create Document (available from 3 June 2026)

`POST /v3/documents`

{% hint style="info" %}
This endpoint will be available from 3 June 2026. Specifications are still subject to change until then.
{% endhint %}

<mark style="color:$primary;">**How this is different from the previous API version (**</mark>[<mark style="color:$primary;">**/v2/documents**</mark>](#create-document-will-be-deprecated-from-1-december-2026)<mark style="color:$primary;">**):**</mark>

* <mark style="color:$primary;">Documents created this endpoint will create documents that utilise the</mark> <mark style="color:$primary;"></mark><mark style="color:$primary;">**new signing flow**</mark><mark style="color:$primary;">. This new signing flow injects signatures of a larger size.</mark>
  * <mark style="color:$primary;">On a regular A4 document, a Sign with Singpass signature will take up an area of 7.78cm x 2.12cm (294 x 80 pixels). This size is dictated by Singpass and cannot be changed (</mark>[<mark style="color:$primary;">reference</mark>](https://docs.sign.singpass.gov.sg/for-relying-parties/ux-guidelines#add-sufficient-signature-placeholder-space-in-your-document)<mark style="color:$primary;">).</mark>

<mark style="color:$primary;">The API changes are:</mark>

1. <mark style="color:$primary;">New optional</mark> <mark style="color:$primary;"></mark><mark style="color:$primary;">`uin`</mark> <mark style="color:$primary;"></mark><mark style="color:$primary;">field (for NRIC/FIN)</mark>
2. <mark style="color:$primary;">Validation will be done on the location of the signature placeholder. If the placeholder does not exist within the bounds of the document, the API will return an error (400 status code).</mark>

**Content type**

The request must be of type `multipart/form-data`.

**Signing modes**

We support two modes of signing invitation: (1) signing by email and (2) signing by link.

* In signing by email, the API caller supplies the email addresses of the signatories, and an email invite is sent out by Signify to the signatories to sign the document.
* In signing by link, no email addresses are supplied by the API caller. Signing links are returned to the API caller, who can then redirect their users to the signing link.

The signing mode is specified in the `documentMode` property of the request body.

Both signing modes require the API caller to specify the location of the signature placeholders.

#### Signing by Email

The mandatory fields in request body are:

1. `documentName` - the document name
2. `recipients` - an array of `{email: string, requiredSignatures: requiredSignature[], customMessage?: string, uin?: string}`
3. `file` - the file binary

The optional fields in the request body are:

1. `documentMode` - For signing by email, you may specify this to be `email`. If not specified, this will default to `email`.
2. `redirectUrl` - Signify will redirect to this redirectUrl upon completion of signing (by each email receipient). Only URLs with a `https` protocol, and a `.gov.sg` domain will be accepted.

<table><thead><tr><th width="187">Property</th><th>Type</th><th width="111">Required?</th><th>Restrictions</th></tr></thead><tbody><tr><td>documentName</td><td><code>string</code></td><td>Yes</td><td><p>Must have at least 4 characters and at most 100 characters.<br><br>Only the following character set is allowed:</p><pre><code><strong>a-zA-Z0-9_\-./() &#x26;`;'"
</strong></code></pre></td></tr><tr><td>recipients</td><td>An array of <code>{email: string, requiredSignatures: requiredSignature[], customMessage?: string, uin?: string}</code></td><td>Yes</td><td><p>Email addresses must be unique. <br><br><code>requiredSignatures</code> is an array of the <code>requiredSignature</code> object, which has the type:</p><pre class="language-typescript"><code class="lang-typescript">{ page: number,
positionX: number,
positionY: number }
</code></pre><ul><li><code>page</code> represents the page that the fixed signature placeholder is located</li><li><code>positionX</code> and <code>positionY</code> are numbers between 0 to 1. They represent the location of the fixed signature as a percentage of the total document's width and height respectively.<br>Refer below for instructions on how to retrieve these coordinates.</li><li><code>requiredSignature</code> array has a max length of 20 per email recipient</li></ul><p></p><p><code>customMessage</code> is an optional attribute of 1 to 1000 characters. The message will be sent out as part of the email invitation to the recipient.<br><br><mark style="background-color:yellow;"><code>uin</code> is an optional attribute of a valid  NRIC/FIN authorised to view the document. If provided, only this NRIC/FIN will be able to view the document.</mark></p></td></tr><tr><td>file</td><td><code>binary</code></td><td>Yes</td><td>Up to 10MB</td></tr><tr><td>documentMode</td><td><code>email</code> literal</td><td>No, optional</td><td></td></tr><tr><td>redirectUrl</td><td><code>string</code></td><td>No, optional</td><td>Must have a <code>https</code> protocol and a <code>.gov.sg</code> domain</td></tr></tbody></table>

How to obtain positionX and positionY:

One way to obtain `positionX` and `positionY` is to

1. Create a document via Signify web <https://signify.gov.sg/>
2. Inspect the network call to <https://app.signify.gov.sg/api/v1/documents/upload>, extract `positionX` and `positionY` from the payload
3. Use these values in your API call

Sample CURL request:

```sh
curl -X POST "https://app.signify.gov.sg/public/v2/documents" \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: multipart/form-data' \
  -F 'documentName=Testing API' \
  -F 'recipients=[{"email":"<EMAIL_1>","requiredSignatures":[{"page":1, "positionX":0.1, "positionY":0.2}, {"page":1, "positionX":0.2, "positionY":0.3}], "customMessage": "Please sign on Page 3."},{"email":"<EMAIL_2>","requiredSignatures":[{"page":1, "positionX":0.5, "positionY":0.5}]}]' \
  -F 'file=@"<FILE_PATH>"'
```

**Returns:**

```json
{
    "documentId": 20
}
```

**Explanation of fields returned:**

| Field returned | What it means                         | Example |
| -------------- | ------------------------------------- | ------- |
| `documentId`   | The unique identifier of the document | 5       |

#### Signing by Link

The mandatory fields in request body are:

1. `documentName` - the document name
2. `totalSignaturesByLink` - a length 1 array of `{requiredSignatures: requiredSignature[]}`
3. `file` - the file binary
4. `documentMode` - this must be specified as `link`

The optional fields in the request body are:

1. `redirectUrl` - Signify will redirect to this redirectUrl upon completion of signing. Only URLs with a `https` protocol, and a `.gov.sg` domain will be accepted.
2. `uin` - Array of valid NRICs/FINs. If provided, only these NRIC/FINs will be able to view the document.

<table><thead><tr><th>Property</th><th>Type</th><th>Required?</th><th>Restrictions</th></tr></thead><tbody><tr><td>documentName</td><td><code>string</code></td><td>Yes</td><td><p>Must have at least 4 characters and at most 100 characters.<br><br>Only the following character set is allowed:</p><pre><code>a-zA-Z0-9_\-./() &#x26;`;'"
</code></pre></td></tr><tr><td><code>totalSignaturesByLink</code></td><td>A length 1 array of <code>{requiredSignatures: requiredSignature[]}</code></td><td>Yes</td><td><p>Array must be of length exactly 1<br></p><p><code>requiredSignature</code> has the type </p><pre class="language-typescript"><code class="lang-typescript">{ page: number,
positionX: number,
positionY: number }
</code></pre><ul><li><code>page</code> represents the page that the fixed signature placeholder is located</li><li><code>positionX</code> and <code>positionY</code> are numbers between 0 to 1. They represent the location of the fixed signature as a percentage of the total document's width and height respectively. Refer below for instructions on how to retrieve these coordinates.</li><li><code>requiredSignature</code> array has a max length of 20</li></ul></td></tr><tr><td>file</td><td><code>binary</code></td><td>Yes</td><td>Up to 10MB</td></tr><tr><td>documentMode</td><td><code>link</code> literal</td><td>Yes</td><td></td></tr><tr><td>redirectUrl</td><td><code>string</code></td><td>No, optional</td><td>Must have a <code>https</code> protocol and a <code>.gov.sg</code> domain</td></tr><tr><td><mark style="background-color:yellow;">uin</mark></td><td><code>string[]</code></td><td><mark style="background-color:yellow;">No</mark></td><td><ul><li><mark style="background-color:yellow;"><code>uin</code> array has a min length of 1</mark></li><li><mark style="background-color:yellow;">Only valid NRIC and FIN numbers are accepted</mark></li><li><mark style="background-color:yellow;">If provided, only these NRICs/FINs will be able to view the document.</mark></li></ul></td></tr></tbody></table>

How to obtain positionX and positionY:

One way to obtain `positionX` and `positionY` is to

1. Create a document via Signify web <https://signify.gov.sg/>
2. Inspect the network call to <https://app.signify.gov.sg/api/v1/documents/upload-link>, extract `positionX` and `positionY` from the payload
3. Use these values in your API call

Sample CURL request:

```sh
curl -X POST "https://app.signify.gov.sg/public/v2/documents" \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: multipart/form-data' \
  -F 'documentName="Document 1"' \
  -F 'totalSignaturesByLink="[{"requiredSignatures": [{"page": 1, "positionX": 0, "positionY": 0}, {"page": 2, "positionX": 0.2, "positionY": 0.3}]} \
  -F 'documentMode="link"' \
  -F 'file=@"<FILE_PATH>"'

```

**Returns:**

```json
{
    "documentId": "3",
    "signingLinks": [
        {
            "signingLink": "https://app.signify.gov.sg/documents/sign/01hfk78xjafvn9n8xn084a9rsn",
            "totalSignatures": 2
        }
    ]
}
```

**Explanation of fields returned:**

<table><thead><tr><th>Field returned</th><th>What it means</th><th>Example</th></tr></thead><tbody><tr><td><code>documentId</code></td><td>The unique identifier of the document</td><td>3</td></tr><tr><td><code>signingLinks</code></td><td>The signing links for this document, in an array.<br><br>For each link, <code>signingLink</code> is the link URL, and <code>totalSignatures</code> is the number of signatures required for that link, as specified during document creation. </td><td><pre><code>[
    {
        "signingLink": "https://app.signify.gov.sg/documents/sign/01hfk78xjafvn9n8xn084a9rsn",
        "totalSignatures": 3
    }
]
</code></pre></td></tr></tbody></table>

###

### Get Documents

`GET /v2/documents`

Sample CURL request:

```bash
curl -X GET "https://app.signify.gov.sg/public/v2/documents" \
  -H 'Authorization: Bearer <API_KEY>'
```

**Returns:**

```json
[
    {
        "id": 3,
        "documentName": "Document 1",
        "expiresAt": "2023-12-19T15:59:59.999Z",
        "createdAt": "2023-11-19T07:21:14.065Z",
        "status": "draft",
        "documentMode": "link"
    },
    {
        "id": 4,
        "documentName": "Document 2",
        "expiresAt": "2023-12-19T15:59:59.999Z",
        "createdAt": "2023-11-19T07:22:21.272Z",
        "status": "draft",
        "documentMode": "email"
    },
    {
        "id": 5,
        "documentName": "Document 3",
        "expiresAt": "2023-12-19T15:59:59.999Z",
        "createdAt": "2023-11-19T08:23:07.277Z",
        "status": "draft",
        "documentMode": "email"
    }
]
```

**Explanation of fields returned:**

| Field returned | What it means                                                                                                    | Example                  |
| -------------- | ---------------------------------------------------------------------------------------------------------------- | ------------------------ |
| `id`           | The unique identifier of the document                                                                            | 6                        |
| `documentName` | The name of the document, as specified during document creation                                                  | Document 1               |
| `expiresAt`    | The expiry time of the document, after which it can no longer be accessed                                        | 2023-12-19T15:59:59.999Z |
| `createdAt`    | The creation time of the document                                                                                | 2023-11-19T08:23:20.488Z |
| `status`       | The status of the document. Either `signed` if all signatures required have been completed, or `draft` otherwise | signed                   |
| `documentMode` | Type of signing for this document. Either `link` if the document is signing by link, or `email` otherwise        | link                     |

### Get Single Document

`GET /v2/documents/:id`

{% hint style="danger" %}
The "documentUrl" property will be deprecated from 1 December 2026. Please refer to the [Download Document endpoint](#download-document) to retrieve the PDF document.
{% endhint %}

Sample CURL request:

```bash
curl -X GET "https://app.signify.gov.sg/public/v2/documents/6" \
  -H 'Authorization: Bearer <API_KEY>'
```

**Returns:**

For signing by email:

```json
{
    "id": 6,
    "documentName": "Document 1",
    "documentUrl": "https://app.signify.gov.sg/api/v1/bucket/01hfkatk5tc2mgxq1wefhyn52d",
    "expiresAt": "2023-12-19T15:59:59.999Z",
    "createdAt": "2023-11-19T08:23:20.488Z",
    "status": "draft",
    "signingInvitations": [
        {
            "signatory": "email1@open.gov.sg",
            "totalSignatures": 3,
            "status": "draft",
            "completedSignatures": []
        },
        {
            "signatory": "email2@open.gov.sg",
            "totalSignatures": 1,
            "status": "signed",
            "completedSignatures": [
                {
                    "name": "MY NAME",
                    "timeStamp": "2023-11-19T08:31:36.000Z"
                }
            ]
        }
    ],
    "documentMode": "email"
}
```

For signing by link:

```json
{
    "id": 313,
    "documentName": "Document 1",
    "documentUrl": "https://app.signify.gov.sg/api/v1/bucket/01hfna3nxdxf9nzvev5hw7aaf1",
    "expiresAt": "2023-12-20T15:59:59.999Z",
    "createdAt": "2023-11-20T02:49:17.105Z",
    "status": "signed",
    "signingInvitations": [
        {
            "signingLink": "https://app.signify.gov.sg/documents/sign/01hfna3p1f095s5aqph2dsjr07",
            "totalSignatures": 3,
            "status": "signed",
            "completedSignatures": [
                {
                    "name": "MY NAME",
                    "timeStamp": "2023-11-20T02:49:37.000Z"
                },
                {
                    "name": "MY NAME",
                    "timeStamp": "2023-11-20T02:50:00.000Z"
                },
                {
                    "name": "MY NAME",
                    "timeStamp": "2023-11-20T02:53:04.000Z"
                }
            ]
        }
    ],
    "documentMode": "link"
}
```

**Explanation of fields returned:**

<table><thead><tr><th>Field returned</th><th>What it means</th><th>Example</th></tr></thead><tbody><tr><td><code>id</code></td><td>The unique identifier of the document</td><td>6</td></tr><tr><td><code>documentName</code></td><td>The name of the document, as specified during document creation</td><td>Document 1</td></tr><tr><td><code>documentUrl</code></td><td><p>The url where the  document file can be retrieved. </p><p></p><p><span data-gb-custom-inline data-tag="emoji" data-code="26a0">⚠️</span> The document file URL is only guaranteed to be valid for 30 minutes. You should refetch the URL again after that time.</p></td><td>https://app.signify.gov.sg/api/v1/bucket/01hfkatk5tc2mgxq1wefhyn52d</td></tr><tr><td><code>expiresAt</code></td><td>The expiry time of the document, after which it can no longer be accessed</td><td>2023-12-19T15:59:59.999Z</td></tr><tr><td><code>createdAt</code></td><td>The creation time of the document</td><td>2023-11-19T08:23:20.488Z</td></tr><tr><td><code>status</code></td><td>The status of the document. Either <code>signed</code> if all signatures required have been completed, or <code>draft</code> otherwise</td><td>signed</td></tr><tr><td><code>signingInvitations</code></td><td><p>Details of the signing invitations sent out.<br><br><code>signatory</code> - Email address of the signatory (only for signing by email) </p><p><code>signingLink</code> - Link for signing (only for signing by link)</p><p><code>totalSignatures</code> - Number of signatures required from this invite</p><p><code>status</code> - <code>signed</code> if all signatures have been collected for this invite, <code>draft</code> otherwise</p><p><code>completedSignatures</code> - details of the signatures already collected</p></td><td><pre><code>{
    "signatory": "email2open.gov.sg",
    "totalSignatures": 1,
    "status": "signed",
    "completedSignatures": [
        {
            "name": "MY NAME",
            "timeStamp": "2023-11-19T08:31:36.000Z"
        }
    ]
}
</code></pre></td></tr><tr><td><code>documentMode</code></td><td>Type of signing for this document. Either <code>link</code> if the document is signing by link, or <code>email</code> otherwise </td><td>link</td></tr></tbody></table>

### Delete Document

`DELETE /v2/documents/:id`

Sample CURL request:

```bash
curl -X DELETE "https://app.signify.gov.sg/public/v2/documents/6" \
  -H 'Authorization: Bearer <API_KEY>'
```

**Returns:**

```json
{
    "message": "Document deleted"
}
```

### Download Document

`GET /v2/documents/:id/download`

{% hint style="info" %}
This endpoint will be available from 3 June 2026. Specifications are still subject to change until then.
{% endhint %}

Sample CURL request:

```bash
curl -X GET "https://app.signify.gov.sg/public/v2/documents/6/download" \
  -H 'Authorization: Bearer <API_KEY>'
```

**Returns:**

Binary PDF file


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://guide.signify.gov.sg/user-guides/api-guide.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.