Endpoints

Overview

Signify exposes REST endpoints for document creation, retrieval, and download. Each endpoint accepts standard HTTP requests with the appropriate method, path, headers, and body.

Environment endpoints

Create Document (will be deprecated from 1 December 2026)

POST /v2/documents

Warning: This endpoint will be deprecated from 1 December 2026. Please switch to the new Create Document endpoint before then.

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 recipient). Only URLs with a https protocol, and a .gov.sg domain will be accepted.

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:

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>"'Copy to clipboardErrorCopied

Returns:

{
    "documentId": 20
}Copy to clipboardErrorCopied

Explanation of fields returned:

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.

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:

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>"'Copy to clipboardErrorCopied

Returns:

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

Explanation of fields returned:

Create Document (available from 3 June 2026)

POST /v3/documents

Warning: This endpoint will be available from 3 June 2026. Specifications are still subject to change until then.

How this is different from the previous API version (/v2/documents):

• Documents created via this endpoint utilise the new signing flow. This new signing flow injects signatures of a larger size.

  • 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 (reference).

The API changes are:

1. New optional allowedIdentifiers field (for NRIC/FIN)

2. 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).

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 recipient). Only URLs with a https protocol, and a .gov.sg domain will be accepted.

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:

curl -X POST "https://app.signify.gov.sg/public/v3/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>"'Copy to clipboardErrorCopied

Returns:

{
    "documentId": 20
}Copy to clipboardErrorCopied

Explanation of fields returned:

Signing by Link

The mandatory fields in request body are:

1. documentName - the document name
2. totalSignaturesByLink - a length 1 array of {requiredSignatures: requiredSignature[], allowedIdentifiers?: []}
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.

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:

curl -X POST "https://app.signify.gov.sg/public/v3/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}], "allowedIdentifiers": ["S8374662I"]}]' \
  -F 'documentMode=link' \
  -F 'file=@"<FILE_PATH>"'Copy to clipboardErrorCopied

Returns:

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

Explanation of fields returned:

Get Documents

GET /v2/documents

Sample CURL request:

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

Returns:

[
    {
        "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"
    }
]Copy to clipboardErrorCopied

Explanation of fields returned:

Get Single Document

GET /v2/documents/:id

Warning: The “documentUrl” property will be deprecated from 1 December 2026. Please refer to the Download Document endpoint to retrieve the PDF document.

Sample CURL request:

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

Returns:

For signing by email:

{
    "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"
}Copy to clipboardErrorCopied

For signing by link:

{
    "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"
}Copy to clipboardErrorCopied

Explanation of fields returned:

Delete Document

DELETE /v2/documents/:id

Sample CURL request:

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

Returns:

{
    "message": "Document deleted"
}Copy to clipboardErrorCopied

Download Document

GET /v2/documents/:id/download

Sample CURL request:

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

Returns:

Binary PDF file