eSemneaza

https://esemneaza.stoplight.io/docs/endpoints
Admin
eSemneaza is a digital signature and document signing platform that provides REST API endpoints for...
Tokens:2,180
Snippets:10
Trust Score:10
Update:9 months ago
Show doc for...
Tokens:
Raw
### Get Completed Document URL

Source: https://esemneaza.stoplight.io/docs/endpoints/2k413ncclo5vd-api-endpoints

Retrieves a temporary URL to view the signed version of the document.

```APIDOC
## GET /api/v1/sign-requests/{id}/completed-document-url

### Description
Retrieves a temporary URL to view the signed version of the document.

### Method
GET

### Endpoint
https://app.esemneaza.ro/api/v1/sign-requests/{id}/completed-document-url

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the sign request.

### Response
#### Success Response (200)
- **completed_document_url** (string) - A temporary URL to access the signed document.

#### Response Example
```json
{
  "completed_document_url": "https://app.esemneaza.ro/view/signed_doc_xyz?token=def456"
}
```
```

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

### Get Document URL

Source: https://esemneaza.stoplight.io/docs/endpoints/2k413ncclo5vd-api-endpoints

Retrieves a temporary URL to view the document associated with a sign request.

```APIDOC
## GET /api/v1/sign-requests/{id}/document-url

### Description
Retrieves a temporary URL to view the document associated with a sign request.

### Method
GET

### Endpoint
https://app.esemneaza.ro/api/v1/sign-requests/{id}/document-url

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the sign request.

### Response
#### Success Response (200)
- **document_url** (string) - A temporary URL to access the document.

#### Response Example
```json
{
  "document_url": "https://app.esemneaza.ro/view/doc_xyz?token=abc123"
}
```
```

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

### List Templates

Source: https://esemneaza.stoplight.io/docs/endpoints/2k413ncclo5vd-api-endpoints

Retrieves a list of available document templates.

```APIDOC
## GET /api/v1/templates

### Description
Retrieves a list of available document templates.

### Method
GET

### Endpoint
https://app.esemneaza.ro/api/v1/templates

### Response
#### Success Response (200)
- **templates** (array) - A list of template objects.
  - **id** (string) - The unique identifier for the template.
  - **name** (string) - The name of the template.

#### Response Example
```json
{
  "templates": [
    {
      "id": "tmpl_abc",
      "name": "Employment Contract"
    },
    {
      "id": "tmpl_def",
      "name": "Non-Disclosure Agreement"
    }
  ]
}
```
```

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

### Create a Sign Request

Source: https://esemneaza.stoplight.io/docs/endpoints/2k413ncclo5vd-api-endpoints

Creates a new sign request. This endpoint allows users to initiate the signing process for a document.

```APIDOC
## POST /api/v1/sign-requests

### Description
Creates a new sign request. This endpoint allows users to initiate the signing process for a document.

### Method
POST

### Endpoint
https://app.esemneaza.ro/api/v1/sign-requests

### Parameters
#### Request Body
- **document_id** (string) - Required - The ID of the document to be signed.
- **recipients** (array) - Required - A list of recipients for the signature.
  - **email** (string) - Required - The email address of the recipient.
  - **name** (string) - Optional - The name of the recipient.
- **message** (string) - Optional - A message to accompany the sign request.

### Request Example
```json
{
  "document_id": "doc_12345",
  "recipients": [
    {
      "email": "recipient@example.com",
      "name": "John Doe"
    }
  ],
  "message": "Please sign this document."
}
```

### Response
#### Success Response (201)
- **id** (string) - The unique identifier for the created sign request.
- **status** (string) - The current status of the sign request.

#### Response Example
```json
{
  "id": "sr_abcdef123",
  "status": "pending"
}
```
```

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

### List Sign Requests

Source: https://esemneaza.stoplight.io/docs/endpoints/2k413ncclo5vd-api-endpoints

Retrieves a list of all sign requests. This endpoint can be used to view the status of multiple signing processes.

```APIDOC
## GET /api/v1/sign-requests

### Description
Retrieves a list of all sign requests. This endpoint can be used to view the status of multiple signing processes.

### Method
GET

### Endpoint
https://app.esemneaza.ro/api/v1/sign-requests

### Parameters
#### Query Parameters
- **status** (string) - Optional - Filter sign requests by status (e.g., 'pending', 'completed', 'canceled').

### Response
#### Success Response (200)
- **sign_requests** (array) - A list of sign request objects.
  - **id** (string) - The unique identifier for the sign request.
  - **status** (string) - The current status of the sign request.

#### Response Example
```json
{
  "sign_requests": [
    {
      "id": "sr_abcdef123",
      "status": "pending"
    },
    {
      "id": "sr_ghijkl456",
      "status": "completed"
    }
  ]
}
```
```

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

### Sign a Request

Source: https://esemneaza.stoplight.io/docs/endpoints/2k413ncclo5vd-api-endpoints

Allows a recipient to sign a sign request. This endpoint is typically used via a signing link.

```APIDOC
## POST /api/v1/sign-requests/{id}/sign

### Description
Allows a recipient to sign a sign request. This endpoint is typically used via a signing link.

### Method
POST

### Endpoint
https://app.esemneaza.ro/api/v1/sign-requests/{id}/sign

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the sign request.

#### Request Body
- **recipient_email** (string) - Required - The email of the recipient performing the signature.
- **signature_data** (string) - Required - The signature data (e.g., base64 encoded image or drawn signature).

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of successful signature.

#### Response Example
```json
{
  "message": "Signature successfully applied to sign request sr_abcdef123."
}
```
```

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

### Retrieve a Sign Request

Source: https://esemneaza.stoplight.io/docs/endpoints/2k413ncclo5vd-api-endpoints

Retrieves the details of a specific sign request using its unique identifier.

```APIDOC
## GET /api/v1/sign-requests/{id}

### Description
Retrieves the details of a specific sign request using its unique identifier.

### Method
GET

### Endpoint
https://app.esemneaza.ro/api/v1/sign-requests/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the sign request.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the sign request.
- **status** (string) - The current status of the sign request.
- **recipients** (array) - A list of recipients.
- **created_at** (string) - Timestamp of creation.

#### Response Example
```json
{
  "id": "sr_abcdef123",
  "status": "pending",
  "recipients": [
    {
      "email": "recipient@example.com",
      "name": "John Doe"
    }
  ],
  "created_at": "2023-10-27T10:00:00Z"
}
```
```

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

### Sign on Behalf of Recipient

Source: https://esemneaza.stoplight.io/docs/endpoints/2k413ncclo5vd-api-endpoints

Enables an authorized user to sign a request on behalf of a recipient. Requires appropriate permissions.

```APIDOC
## POST /api/v1/sign-requests/{id}/sign-on-behalf

### Description
Enables an authorized user to sign a request on behalf of a recipient. Requires appropriate permissions.

### Method
POST

### Endpoint
https://app.esemneaza.ro/api/v1/sign-requests/{id}/sign-on-behalf

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the sign request.

#### Request Body
- **recipient_email** (string) - Required - The email of the recipient the signature is for.
- **signer_email** (string) - Required - The email of the user performing the signature on behalf of the recipient.
- **signature_data** (string) - Required - The signature data.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of successful signature on behalf.

#### Response Example
```json
{
  "message": "Signature successfully applied on behalf of recipient@example.com for sign request sr_abcdef123."
}
```
```

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

### Remind a Recipient

Source: https://esemneaza.stoplight.io/docs/endpoints/2k413ncclo5vd-api-endpoints

Sends a reminder to a specific recipient about an outstanding sign request.

```APIDOC
## POST /api/v1/sign-requests/{id}/remind

### Description
Sends a reminder to a specific recipient about an outstanding sign request.

### Method
POST

### Endpoint
https://app.esemneaza.ro/api/v1/sign-requests/{id}/remind

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the sign request.

#### Request Body
- **recipient_email** (string) - Required - The email of the recipient to remind.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message that a reminder has been sent.

#### Response Example
```json
{
  "message": "Reminder sent to recipient@example.com for sign request sr_abcdef123."
}
```
```

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

### Cancel a Sign Request

Source: https://esemneaza.stoplight.io/docs/endpoints/2k413ncclo5vd-api-endpoints

Cancels an existing sign request. This action cannot be undone.

```APIDOC
## POST /api/v1/sign-requests/{id}/cancel

### Description
Cancels an existing sign request. This action cannot be undone.

### Method
POST

### Endpoint
https://app.esemneaza.ro/api/v1/sign-requests/{id}/cancel

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the sign request to cancel.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the sign request has been canceled.

#### Response Example
```json
{
  "message": "Sign request sr_abcdef123 has been canceled successfully."
}
```
```
Tokens:
Raw