Requesting Signatures

You'll need:

• an access token
• an Account
• a signing integration (e.g. Docusign)

Steps

1. Create the Signature request

This endpoint requires the use of the Blocks Gateway.

ℹ️

Completing this step without the Blocks Gateway

Alternatively, you can complete this step within your Drawer (sidedrawer) by clicking on the three dots on the right side of the desired file and selecting "Request Signatures" from the drop-down menu as shown below:

Then enter the desired signer's information and "Configure and Send Envelope":

In the following HTTP request, provider refers to the Integration through which you will receive signatures. In the example below, {provider} is docusign.

POST https://blocks-gateway-api-sbx.sidedrawersbx.com/api/v1/signatures/sidedrawer/sidedrawer-id/{sidedrawerId}/provider/{provider}/envelopes

Example HTTP Request

https://blocks-gateway-api-sbx.sidedrawersbx.com/api/v1/signatures/sidedrawer/sidedrawer-id/{sidedrawerId}/provider/docusign/envelopes

Example Request Body

{
  "signers":
   [
     {
       "signerName":"Jane Smith",
       "signerEmail":"[email protected]",
       "signerRole":"Signer 1",
       "recipientId":1,
       "routingOrder":0
     }
   ],
 "emailBody":"Please sign",
  "emailSubject":"My_file",
  "redirectURL":"{domain}/core/home/{sidedrawerId}/my-sd/records/{recordId}",
  "recordId":"{recordId}"
}

2.

GET /api/v2/records/sidedrawer/sidedrawer-id/{sidedrawerId}/records/record-id/{recordId}

Example Response

{
    "id": "{recordId}",
    "name": "recordName",
    "description": "",
    "recordTypeName": "legalDocs",
    "recordType": {
        "_id": "{recordTypeId}",
        "name": "legalDocs",
        "logo": "{logoUrl}",
        "displayValue": [
            {
                "description": "",
                "_id": "{displayValueId}",
                "locale": "en-CA",
                "value": "Legal Documents"
            },
            {
                "description": "",
                "_id": "{displayValueId}",
                "locale": "en-US",
                "value": "Legal Documents"
            },
            {
                "description": "",
                "_id": "{displayValueId}",
                "locale": "es-US",
                "value": "Documentos Legales"
            },
            {
                "description": "",
                "_id": "{displayValueId}",
                "locale": "fr-CA",
                "value": "Documents le'gaux"
            }
        ],
        "orderId": 1000,
        "universal": false,
        "sidedrawerTypes": [
            {
                "sidedrawerType": "individual"
            }
        ]
    },
    "recordSubtypeName": "other",
    "recordSubtype": {
        "id": "{recordSubtypeId}",
        "_id": "{recordSubtypeId}",
        "recordType": {
            "_id": "{recordTypeId}",
            "universal": false,
            "sidedrawerTypes": []
        },
        "name": "other",
        "logo": "{logoUrl}",
        "displayValue": [
            {
                "_id": "{displayValueId}",
                "locale": "en-CA",
                "value": "Other"
            },
            {
                "_id": "{displayValueId}",
                "locale": "en-US",
                "value": "Other"
            },
            {
                "_id": "{displayValueId}",
                "locale": "es-US",
                "value": "Other"
            }
        ],
        "orderId": 0,
        "recordsSections": {
            "sectionDescription": true,
            "sectionFiles": true,
            "sectionLinkedRecords": true,
            "sectionCollaborators": true,
            "sectionSpecificFields": true,
            "sectionCustomFields": true,
            "sectionReminders": true,
            "sectionSignatures": true
        }
    },
    "recordSubtypeOther": "",
    "lastModifiedBy": "Jane Smith",
    "active": true,
    "editable": true,
    "storageLocation": "",
    "updatedAt": "2024-10-03T23:19:54.534Z",
    "recordDetails": {
        "customFields": [],
        "createdAt": "2024-10-03T23:19:54.542Z",
        "updatedAt": "2024-10-03T23:19:54.542Z"
    },
    "userSidedrawerRole": [
        "sd_editor"
    ],
    "userRecordRole": [],
    "externalKeys": []
}

3.

GET /api/v2/records/sidedrawer/sidedrawer-id/{sidedrawerId}/records

JSON

{
    "data": [
        {
            "id": "{recordId}",
            "name": "recordName",
            "storageLocation": "",
            "recordSubtypeOther": "",
            "description": "",
            "recordSubtype": {
                "id": "{recordSubtypeId}",
                "name": "other",
                "logo": "{logoUrl}",
                "displayValue": [
                    {
                        "locale": "en-CA",
                        "value": "Other"
                    }
                ]
            },
            "recordType": {
                "name": "legalDocs",
                "logo": "{logoUrl}",
                "displayValue": [
                    {
                        "locale": "en-CA",
                        "value": "Legal Documents"
                    }
                ]
            },
            "active": true,
            "updatedAt": "2024-11-20T12:48:44.369Z",
            "lastModifiedBy": "Jane Smith",
            "editable": true,
            "externalKeys": []
        }
    ],
    "hasMore": false,
    "nextPage": null,
    "previousPage": null,
    "totalCount": 1
}

4. Get Envelopes

Return any Envelopes within the Folder (record). For any Envelopes, this will return an envelopeId, through which you can retrieve about that specific Envelope.

GET /api/v1/signatures/sidedrawer/sidedrawer-id/{sidedrawerId}/records/record-id/{recordId}/envelopes

JSON

{
    "data": [
        {
            "createdDateTime": "2024-11-20T12:40:27.9830000Z",
            "emailSubject": "My_file",
            "envelopeId": "{envelopeId}",
            "lastModifiedDateTime": "2024-11-20T12:47:37.1870000Z",
            "sender": {
                "email": "[email protected]"
            },
            "sentDateTime": "2024-11-20T12:47:37.9370000Z",
            "status": "completed"
        },
        {
            "createdDateTime": "2024-11-20T13:01:37.8000000Z",
            "emailSubject": "My_file",
            "envelopeId": "{envelopeId2}",
            "lastModifiedDateTime": "2024-11-20T13:01:37.8300000Z",
            "sender": {
                "email": "[email protected]"
            },
            "status": "created"
        }
    ],
    "hasMore": false,
    "nextPage": null,
    "previousPage": null,
    "totalCount": 2
}