Signit API

https://signit.stoplight.io/docs/
Admin
Signit API is a platform for managing electronic signatures, document uploads, signature requests,...
Tokens:2,382
Snippets:8
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### API Rate Limits and Rules

Source: https://signit.stoplight.io/docs/api/uw3tukftjdtd9-api-rate-limits-and-rules

Documentation for Signit's API rate limits and rules, as provided by Stoplight.

```APIDOC
API Rate Limits and Rules:
  This section details the rate limiting policies and usage rules for the Signit API.
  It is crucial for developers to adhere to these limits to ensure stable and reliable access to the API.
  Specific limits and rules may vary based on the API version and subscription plan.

  Key aspects covered:
  - Request limits per time period (e.g., per minute, per hour, per day)
  - Bandwidth limitations
  - Specific rules for certain endpoints or operations
  - Error responses related to exceeding limits (e.g., HTTP 429 Too Many Requests)

  For detailed information and specific values, please refer to the official Stoplight documentation linked below:
  [https://signit.stoplight.io/docs/api/uw3tukftjdtd9-api-rate-limits-and-rules](https://signit.stoplight.io/docs/api/uw3tukftjdtd9-api-rate-limits-and-rules)
```

--------------------------------

### Signit API Reference

Source: https://signit.stoplight.io/docs/api/3onl1vv9x2oyj-signit-api

This section details the available API endpoints for interacting with the Signit platform. It includes information on authentication, request methods, parameters, and response structures for various operations such as creating signature requests, managing documents, and retrieving user information.

```APIDOC
Signit API Documentation

Base URL: https://api.signit.io/v1

Authentication:
  - API Key: X-API-Key header

Endpoints:

1. **Documents**
   - GET /documents: Retrieve a list of all documents.
     - Parameters:
       - `status` (string, optional): Filter by document status (e.g., 'pending', 'completed', 'declined').
       - `limit` (integer, optional): Maximum number of documents to return.
       - `offset` (integer, optional): Number of documents to skip.
     - Returns: Array of document objects.
   - POST /documents: Upload a new document.
     - Request Body:
       - `file` (file): The document file to upload.
       - `name` (string, required): The name of the document.
       - `recipients` (array of objects, required): List of recipients with `email` and `role`.
     - Returns: The created document object.
   - GET /documents/{documentId}: Retrieve a specific document by its ID.
     - Parameters:
       - `documentId` (string, required): The ID of the document.
     - Returns: The document object.

2. **Signatures**
   - POST /signatures/{documentId}: Request a signature for a document.
     - Parameters:
       - `documentId` (string, required): The ID of the document.
     - Request Body:
       - `recipientId` (string, required): The ID of the recipient.
       - `signer_name` (string, optional): The name of the signer.
       - `signer_email` (string, optional): The email of the signer.
     - Returns: Signature request details.
   - GET /signatures/{signatureId}: Retrieve signature details.
     - Parameters:
       - `signatureId` (string, required): The ID of the signature.
     - Returns: Signature object.

3. **Users**
   - GET /users/me: Retrieve information about the authenticated user.
     - Returns: User object.

Error Handling:
  - Standard HTTP status codes (400, 401, 403, 404, 500).
  - Error response format: {"error": "Error message"}

Example Usage (Node.js):
```javascript
const axios = require('axios');

const apiKey = 'YOUR_API_KEY';
const documentId = 'doc_123';

axios.get(`https://api.signit.io/v1/documents/${documentId}`, {
  headers: {
    'X-API-Key': apiKey
  }
})
.then(response => {
  console.log(response.data);
})
.catch(error => {
  console.error('Error fetching document:', error.response.data);
});
```
```

--------------------------------

### Signit API - Notification and Verification Methods

Source: https://signit.stoplight.io/docs/api/yoxzg9blzexdp-changelog

Details on supported notification methods and signatory verification processes, including SMS, Absher, and Nafath.

```APIDOC
APIDOC:
  Signit API - Notification and Verification Methods

  Features:
  - Add SMS as notification method.
  - SMS, Absher & Nafath signatory verification.
  - Add multiple nafath signatories.
```

--------------------------------

### Signit API - Signature Request Management

Source: https://signit.stoplight.io/docs/api/yoxzg9blzexdp-changelog

This section covers core functionalities for managing signature requests, including creation, reminders, status checks, downloading associated files, and cancellation.

```APIDOC
APIDOC:
  Signit API - Signature Request Management

  Features:
  - Signature request creation.
  - Signature request reminders.
  - Signature request status check.
  - Download files associated with a signature request.
  - Cancelling a signature request.
```

--------------------------------

### Signit API - Signing Orders and Customization

Source: https://signit.stoplight.io/docs/api/yoxzg9blzexdp-changelog

Features related to the order of signing and customization of fields and appearance.

```APIDOC
APIDOC:
  Signit API - Signing Orders and Customization

  Features:
  - Signing orders.
  - Field appearance customization.
  - Add font styling (bold, italic, underline).
  - Add pre-filled fields.
  - Add read-only fields.
  - Add radio button fields.
  - Add checkbox field.
  - Add color to text fields appearance.
```

--------------------------------

### Signit API - Document and Audit Trail

Source: https://signit.stoplight.io/docs/api/yoxzg9blzexdp-changelog

Functionalities related to document handling and audit trail retrieval.

```APIDOC
APIDOC:
  Signit API - Document and Audit Trail

  Features:
  - Document upload.
  - Audit trail records retrieval.
```

--------------------------------

### Signit API - Template Field Functionality

Source: https://signit.stoplight.io/docs/api/yoxzg9blzexdp-changelog

This section details API enhancements related to template fields, including filling text, date, and checkbox fields, retrieving field information, and modifying field properties like read-only and required status.

```APIDOC
APIDOC:
  Signit API - Template Field Functionality

  Features:
  - Ability to fill in text fields during signature request creation from templates.
  - Ability to fill in date fields during signature request creation from templates.
  - Ability to fill in checkbox fields during signature request creation from templates.
  - Ability to retrieve fields information from templates.
  - Ability to change fields properties (read_only, required) for (text, date) during signature request creation from templates.
  - Add obtaining template information.
  - Add creating signature request from predefined template.
  - Add font styling (bold, italic, underline) for fields.
  - Add pre-filled fields.
  - Add read-only fields.
  - Add radio button fields.
  - Add checkbox field.
  - Add color to text fields appearance.
```

--------------------------------

### Signit API - Signatory Attributes

Source: https://signit.stoplight.io/docs/api/yoxzg9blzexdp-changelog

Details on attributes that can be associated with signatories.

```APIDOC
APIDOC:
  Signit API - Signatory Attributes

  Features:
  - Language attribute to signatory.
```
Tokens:
Raw