Overview
This API documentation describes the steps and specifications required to create a signature request using Legistify's e-signature service and to receive the signed document data through a webhook.
Integration Steps
1. Obtain API Token: Secure the X-Auth-Token from Legistify for authentication.
2. Prepare the PDF File: Convert the PDF file into a base64-encoded string.
3. Create Signature Request:
Configure the headers and request body as outlined.
Perform a POST request to the Legistify API endpoint.
4. Handle Response: Capture the signatureRequestId and contractId from the response.
5. Set Up Webhook:
Provide your system with the endpoint URL to receive signed document data.
Ensure the webhook is protected with proper authorization.
6. Receive Signed Data: Your system will get the signed document, audit trail, and signature details via the webhook after signing is completed.
Process
1. Creating a Signature Request
Method: POST
Headers:
Content-Type: application/json
X-Auth-Token: Token Provided By Legistify
Request Body:
signers: An array of signer objects, each including:
name: Signer's name.
email: Signer's email.
phoneNumber: Signer's phone number.
contractId: A unique identifier for the contract.
contractName: The name of the contract, used as the file name.
file: A base64-encoded string of the PDF file.
reminder: The reminder frequency for signing (options: daily, weekly, monthly, off).
Success Response:
Status code 200 with a response containing the status, signature request ID, and contract ID.
Error Response:
Status codes 400 or 500 with an error message.
2. Webhook for Receiving Signed Data
Endpoint: To be provided by your system.
Method: POST
Request Body:
signers: An array of signer objects, each including:
name: Signer's name.
email: Signer's email.
phoneNumber: Signer's phone number.
signedAt: Timestamp of when the document was signed.
contractId: The unique identifier for the contract.
file: A base64-encoded string of the signed PDF file.
auditTrail: A base64-encoded string of the audit trail.
contractName: The name of the contract.
signatureRequestId: The ID generated by Legistify for the signature request.
Response from Your System:
Status code 200 with a confirmation response.
*Note: This document provides guidance for integrating Legistify’s e-signature service with your system, ensuring a seamless and secure signing process. Webhook authorization is required and will be provided by Legistify.