Introduction
Welcome to the EasyInk Public API documentation. Our API allows you to integrate e-signature capabilities directly into your applications, enabling seamless management of signing workflows, documents, and participants.
Overview
The EasyInk API is built on REST principles and provides a robust set of endpoints to:
- Create and manage Signing Session Drafts.
- Upload and process Documents.
- Add and configure Participants (Signers, CC).
- Define Signature Fields and their placement.
- Orchestrate sequential or parallel Signing Orders.
- Monitor the status of active Signing Sessions.
- Download completed Signed Documents.
Environments
We provide two environments for integration and production use:
| Environment | Base URL | Identity Provider URL |
|---|---|---|
| Production | https://api.easyink.io | https://identity.easyink.io |
| Staging | https://api-staging.easyink.io | https://identity-staging.easyink.io |
Authentication
All API requests require authentication using JWT Bearer tokens. The API uses the OAuth 2.0 Authorization Code Flow (with PKCE).
Obtaining a Token
- Step 1: Get Client Secret – Contact your EasyInk administrator to receive your
client_idandclient_secret. - Step 2: Get Authorization Code – Redirect the user to the
/connect/authorizeendpoint. - Step 3: Exchange Code for Token – Exchange the received code for an
access_tokenvia the/connect/tokenendpoint.
For detailed authentication steps and examples, please refer to the Authentication section in the API Reference.
Including the Token
Include the token in the Authorization header of every request:
Authorization: Bearer {your-jwt-token}
Error Handling
The API uses standard HTTP status codes to indicate the success or failure of requests. In case of an error, the response body follows a consistent format:
{
"error": {
"code": "ValidationError",
"message": "The provided email address is invalid.",
"innerErrors": [ ... ]
}
}
Common Status Codes
200 OK– Request succeeded.201 Created– Resource created successfully.204 No Content– Request succeeded (no response body).400 Bad Request– Validation failed or invalid request.401 Unauthorized– Missing or invalid authentication token.403 Forbidden– Insufficient permissions.404 Not Found– Resource does not exist.500 Internal Server Error– An unexpected error occurred on our end.
Support
If you encounter any issues or have questions regarding the integration, please contact our support team at easyinksupport@argo34.com.