### Get Company Response Sample

Source: https://api.signly.nl/documentation/index

This is a sample JSON response for a GET request to retrieve company information. It includes details such as ID, name, phone, logo URL, settings, payment plans, credits, and address.

```json
{
  "id": 0,
  "name": "string",
  "phone": "string",
  "logo_url": "string",
  "settings": {
    "mail": {
      "key": "string"
    }
  },
  "payment_plans": [
    {
      "name": "string",
      "features": [
        "string"
      ],
      "price": {
        "type": "string",
        "price": 0
      },
      "deprecated": true,
      "valid_from": "2019-08-24T14:15:22Z"
    }
  ],
  "current_payment_plan": {
    "name": "string",
    "features": [
      "string"
    ],
    "price": {
      "type": "string",
      "price": 0
    },
    "deprecated": true,
    "valid_from": "2019-08-24T14:15:22Z"
  },
  "credits": 0,
  "next_payment_date": "2019-08-24T14:15:22Z",
  "customFields": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "required": true
    }
  ],
  "max_signers": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "address": {
    "tnv": "string",
    "street": "string",
    "housenumber": 0,
    "housenumber_addition": "string",
    "postal": "string",
    "city": "string"
  }
}
```

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

### Webhook Data Structure Example

Source: https://api.signly.nl/documentation/index

This is an example of the data structure sent to a webhook URL when an event occurs. It includes the event type, company ID, department ID, event-specific data, and dispatch time.

```json
{
  "event_type": "THE EVENT TYPE",
  "company_id": "THE COMPANY ID",
  "department_id": "THE DEPARTMENT ID",
  "data": {},
  "dispatched_at": "THE TIME OF WEBHOOK DISPATCH"
}
```

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

### Get Users Response Sample

Source: https://api.signly.nl/documentation/index

This is a sample JSON response for retrieving a paginated list of users. It includes an array of user objects and pagination details.

```json
{
  "data": [
    {
      "id": 0,
      "name": "string",
      "email": "user@example.com",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "total": 0,
  "per_page": 0,
  "current_page": 0
}
```

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

### Get Templates Response Sample

Source: https://api.signly.nl/documentation/index

This is a sample JSON response when retrieving a list of templates. It includes an array of template objects, pagination details, and total counts.

```json
{
  "data": [
    {
      "id": 0,
      "name": "string",
      "variables": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "total": 0,
  "per_page": 0,
  "current_page": 0
}
```

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

### Get Verification Response Sample

Source: https://api.signly.nl/documentation/index

Sample JSON response for retrieving details of a single verification. Includes verification ID, type, state, timestamps, and options.

```json
{
  "id": 0,
  "type": 0,
  "state_id": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "verification_options": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}
```

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

### Get Templates - API Request

Source: https://api.signly.nl/documentation/index

Retrieves a paginated list of templates. This endpoint requires JWT authentication and supports query parameters for ordering, pagination, and filtering.

```http
GET /api/templates?order=id,desc&limit=10&page=1
Host: api.signly.nl
Authorization: Bearer YOUR_JWT_TOKEN
```

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

### Get Actions List

Source: https://api.signly.nl/documentation/index

Retrieves a paginated list of actions associated with a specific signer. Requires an access token for authorization.

```json
{
  "data": [
    {
      "id": 0,
      "type": 0,
      "comment": "string",
      "times": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "total": 0,
  "per_page": 0,
  "current_page": 0
}
```

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

### Get Template by ID Response Sample

Source: https://api.signly.nl/documentation/index

This is a sample JSON response when retrieving a single template by its ID. It returns the details of the specified template.

```json
{
  "id": 0,
  "name": "string",
  "variables": [
    "string"
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
```

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

### Get Activation Token

Source: https://api.signly.nl/documentation/docs

Retrieves activation details using a provided token. This is a GET request. Returns 200 if activation is found, 404 otherwise.

```json
{
    "get": {
        "tags": [
            "Auth"
        ],
        "summary": "Get activation",
        "operationId": "getActivation",
        "parameters": [
            {
                "name": "token",
                "in": "path",
                "description": "Activate token",
                "required": true,
                "schema": {
                    "type": "string"
                }
            }
        ],
        "responses": {
            "200": {
                "description": "Activation found"
            },
            "404": {
                "description": "Not found"
            }
        }
    }
}
```

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

### Get Departments Query Parameters

Source: https://api.signly.nl/documentation/index

This outlines the query parameters available for fetching departments. It includes options for ordering, pagination (page and limit), and filtering by various fields.

```json
{
  "order": "string",
  "page": "integer",
  "limit": "integer",
  "filters": [
    {
      "id": "string",
      "name": "string",
      "mail_from": "string",
      "mail_name": "string",
      "hostname": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  ]
}
```

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

### Get Departments

Source: https://api.signly.nl/documentation/index

Retrieves a paginated list of departments. Requires authentication. Returns a 200 status code with department data or 403 if unauthenticated.

```HTTP
GET /api/departments
https://api.signly.nl/api/departments
```

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

### Get Single Action

Source: https://api.signly.nl/documentation/index

Retrieves details for a specific action using its ID. Requires an access token for authorization.

```json
{
  "id": 0,
  "type": 0,
  "comment": "string",
  "times": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
```

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

### Get Signers Verifications Response Sample

Source: https://api.signly.nl/documentation/index

Sample JSON response for retrieving a paginated list of verifications for a signer. Includes data, total count, and pagination information.

```json
{
  "data": [
    {
      "id": 0,
      "type": 0,
      "state_id": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "verification_options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "total": 0,
  "per_page": 0,
  "current_page": 0
}
```

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

### Get Signer Link Response Sample

Source: https://api.signly.nl/documentation/index

A sample JSON response containing the signing link for a specific signer. This is used to provide users access to the document for signing.

```json
{
  "link": "string"
}
```

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

### Get Current User Response Sample

Source: https://api.signly.nl/documentation/index

This is a sample JSON response for retrieving the current authenticated user's information. It includes user ID, name, email, and timestamps.

```json
{
  "id": 0,
  "name": "string",
  "email": "user@example.com",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
```

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

### Get Payment Plan Response Sample

Source: https://api.signly.nl/documentation/index

This is a sample JSON response for retrieving payment plan details. It includes information about the plan's name, features, price, deprecation status, and validity period.

```json
{
  "name": "string",
  "features": [
    "string"
  ],
  "price": {
    "type": "string",
    "price": 0
  },
  "deprecated": true,
  "valid_from": "2019-08-24T14:15:22Z"
}
```

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

### Get Signer Actions

Source: https://api.signly.nl/documentation/index

Retrieves a list of actions associated with a specific signer. Supports filtering and ordering. Requires access token authorization.

```HTTP
GET /api/signers/{signerId}/actions
https://api.signly.nl/api/signers/{signerId}/actions
```

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

### Get States - API Request

Source: https://api.signly.nl/documentation/index

Retrieves a list of all available states. This endpoint requires either an access token or a JWT for authentication and returns a paginated list of states.

```http
GET /api/states
Host: api.signly.nl
Authorization: Bearer YOUR_ACCESS_TOKEN
```

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

### Get Signer Response Sample

Source: https://api.signly.nl/documentation/index

Provides a sample JSON response for retrieving a single signer's details. This includes fields like ID, name, email, and timestamps.

```json
{
  "id": 0,
  "firstname": "string",
  "lastname": "string",
  "fullname": "string",
  "email": "user@example.com",
  "locale": "string",
  "reminder_after": 0,
  "max_reminders": 0,
  "state_id": 0,
  "responded_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
```

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

### Get Access Tokens

Source: https://api.signly.nl/documentation/index

Retrieves a paginated list of access tokens. Supports ordering and filtering by fields like id, name, description, created_at, and updated_at. Requires JWT authorization.

```HTTP
GET /api/access-tokens
https://api.signly.nl/api/access-tokens
```

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

### Get Signers List

Source: https://api.signly.nl/documentation/index

Retrieves a paginated list of signers for a given sign request. Supports filtering, ordering, and pagination. Requires an access token.

```json
{
  "data": [
    {
      "id": 0,
      "firstname": "string",
      "lastname": "string",
      "fullname": "string",
      "email": "user@example.com",
      "locale": "string",
      "reminder_after": 0,
      "max_reminders": 0,
      "state_id": 0,
      "responded_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "total": 0,
  "per_page": 0,
  "current_page": 0
}
```

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

### Get Sign Requests Response Sample

Source: https://api.signly.nl/documentation/index

This JSON response provides a paginated list of sign requests. It includes details for each request such as ID, signers, states, and timestamps.

```json
{
  "data": [
    {
      "id": 0,
      "emails": [
        "user@example.com"
      ],
      "credits_cost": 0,
      "files_deleted": 0,
      "expires_at": "2019-08-24T14:15:22Z",
      "cancelled_at": "2019-08-24T14:15:22Z",
      "completed_at": "2019-08-24T14:15:22Z",
      "state_id": 0,
      "viewer_user": {
        "id": 0,
        "name": "string"
      },
      "custom_field_values": [
        {
          "name": "string",
          "value": null
        }
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "gdpr_purged_at": "2019-08-24T14:15:22Z",
      "estimated_gdpr_purge_at": "2019-08-24T14:15:22Z",
      "signers": [
        {
          "id": 0,
          "firstname": "string",
          "lastname": "string",
          "fullname": "string",
          "email": "user@example.com",
          "locale": "string",
          "reminder_after": 0,
          "max_reminders": 0,
          "state_id": 0,
          "responded_at": "2019-08-24T14:15:22Z",
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z"
        }
      ],
      "signables": [
        {
          "id": 0,
          "type": 0,
          "name": "string",
          "company_name": "string",
          "description": "string",
          "options": {},
          "state_id": 0,
          "marked_at": "2019-08-24T14:15:22Z",
          "signed_at": "2019-08-24T14:15:22Z",
          "file_deleted_at": "2019-08-24T14:15:22Z",
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z"
        }
      ]
    }
  ],
  "total": 0,
  "per_page": 0,
  "current_page": 0
}
```

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

### Get Invoices (JSON Response Sample)

Source: https://api.signly.nl/documentation/index

Provides a sample JSON response for retrieving a list of invoices. This includes details like invoice number, debtor information, dates, address, and line items. It's used to understand the structure of invoice data returned by the API.

```json
{
  "data": [
    {
      "id": 0,
      "invoice_no": "string",
      "debtor_no": "string",
      "debtor_name": "string",
      "invoice_date": "2019-08-24T14:15:22Z",
      "address": {
        "tnv": "string",
        "street": "string",
        "housenumber": 0,
        "housenumber_addition": "string",
        "postal": "string",
        "city": "string"
      },
      "invoice_lines": [
        {
          "description": "string",
          "value": 0.1,
          "tax": 0.1,
          "tax_percentage": 0,
          "amount": 0.1
        }
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "total": 0,
  "per_page": 0,
  "current_page": 0
}
```

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

### Get Messages (JSON Response Sample)

Source: https://api.signly.nl/documentation/index

Provides a sample JSON response for retrieving a paginated list of messages. The response includes message details such as ID, subject, content, sender, recipients, type, and timestamps. It also contains pagination information.

```json
{
  "data": [
    {
      "id": 0,
      "attempts": 0,
      "subject": "string",
      "message": "string",
      "extern_id": "string",
      "from": "string",
      "to": [
        "user@example.com"
      ],
      "type": "email",
      "provider": "string",
      "cost": 0.1,
      "cost_type": "string",
      "sent_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "total": 0,
  "per_page": 0,
  "current_page": 0
}
```

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

### Get User API Response (200)

Source: https://api.signly.nl/documentation/index

This snippet shows the JSON response when a single user is successfully retrieved (HTTP 200). It includes user details and timestamps.

```json
{
  "id": 0,
  "name": "string",
  "email": "user@example.com",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
```

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

### Get Signable File - API Request

Source: https://api.signly.nl/documentation/index

Fetches the signed file of a specific signable document. Authentication with an access token is necessary. This endpoint returns the binary content of the signed file.

```http
GET /api/signables/{signableId}/file
Host: api.signly.nl
Authorization: Bearer YOUR_ACCESS_TOKEN
```

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

### Get Single Invoice (JSON Response Sample)

Source: https://api.signly.nl/documentation/index

Illustrates the JSON structure for a single invoice when retrieved via the API. This response contains detailed information about a specific invoice, including its associated address and line items.

```json
{
  "id": 0,
  "invoice_no": "string",
  "debtor_no": "string",
  "debtor_name": "string",
  "invoice_date": "2019-08-24T14:15:22Z",
  "address": {
    "tnv": "string",
    "street": "string",
    "housenumber": 0,
    "housenumber_addition": "string",
    "postal": "string",
    "city": "string"
  },
  "invoice_lines": [
    {
      "description": "string",
      "value": 0.1,
      "tax": 0.1,
      "tax_percentage": 0,
      "amount": 0.1
    }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
```

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

### Update Signer Response Sample

Source: https://api.signly.nl/documentation/index

Provides a sample JSON response upon successful update of a signer's details. It returns the updated signer object, similar to the get signer response.

```json
{
  "id": 0,
  "firstname": "string",
  "lastname": "string",
  "fullname": "string",
  "email": "user@example.com",
  "locale": "string",
  "reminder_after": 0,
  "max_reminders": 0,
  "state_id": 0,
  "responded_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
```

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

### Get Recurring Payment Status Response Sample

Source: https://api.signly.nl/documentation/index

This is a sample JSON response for retrieving the recurring payment status of a company. It indicates whether the company can withdraw funds.

```json
{
  "can_withdraw": true
}
```

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

### Get Locales (JSON Response Sample)

Source: https://api.signly.nl/documentation/index

Shows the expected JSON format for a response that lists available locales. Each locale object contains a 'locale' code and its corresponding 'name'. This is useful for applications that need to support multiple languages or regions.

```json
[
  {
    "locale": "string",
    "name": "string"
  }
]
```

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

### Get Template File API

Source: https://api.signly.nl/documentation/docs

Retrieves a template file, typically a PDF, associated with a given template ID. Requires authentication. The response includes Content-Disposition and Content-Type headers.

```json
{
    "get": {
        "tags": [
            "Template"
        ],
        "summary": "Template file",
        "operationId": "showTemplateFile",
        "parameters": [
            {
                "name": "templateId",
                "in": "path",
                "description": "Template ID",
                "required": true,
                "schema": {
                    "type": "integer",
                    "format": "int64"
                }
            }
        ],
        "responses": {
            "200": {
                "description": "Single template file",
                "headers": {
                    "Content-Disposition": {
                        "description": "attachment; filename=TEMPLATE.pdf",
                        "schema": {
                            "type": "string"
                        }
                    },
                    "Content-Type": {
                        "description": "application/pdf",
                        "schema": {
                            "type": "string"
                        }
                    }
                },
                "content": {
                    "application/pdf": {
                        "schema": {
                            "type": "string",
                            "format": "binary"
                        }
                    }
                }
            },
            "403": {
                "description": "Unauthenticated"
            },
            "404": {
                "description": "Not found"
            }
        },
        "security": [
            {
                "access_token": []
            }
        ]
    }
}
```

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

### Get Signables for Sign Request

Source: https://api.signly.nl/documentation/index

Fetches a paginated list of signables for a specific sign request. Supports pagination, limiting results, ordering, and filtering by various fields. Requires the sign request ID and access token for authorization.

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

### Get Invoices

Source: https://api.signly.nl/documentation/index

Retrieves a paginated list of invoices. Requires JWT authorization. Supports query parameters for ordering, pagination (page, limit), and filtering. Returns a 200 status code with invoice data or 403 if unauthenticated.

```HTTP
GET /api/invoices
https://api.signly.nl/api/invoices
```

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

### Get Templates API

Source: https://api.signly.nl/documentation/docs

This endpoint retrieves a paginated list of templates. It requires authentication and returns a list of templates in JSON format. It also handles unauthenticated requests by returning a 403 error.

```json
{
    "get": {
        "description": "A paginated list with templates",
        "content": {
            "application/json": {
                "schema": {
                    "$ref": "#/components/schemas/TemplatePagination"
                }
            }
        }
    },
    "403": {
        "description": "Unauthenticated"
    }
}
```

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

### Get Webhook Requests API Response (200)

Source: https://api.signly.nl/documentation/index

This snippet shows the JSON response for retrieving a paginated list of webhook requests (HTTP 200). It includes data, total count, and pagination details.

```json
{
  "data": [
    {
      "id": 0,
      "attempts": 0,
      "url": "string",
      "responses": [
        {
          "status_code": 0,
          "message": "string",
          "sent_data": "string",
          "duration": 0.1
        }
      ],
      "succeeded_at": "2019-08-24T14:15:22Z",
      "failed_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "total": 0,
  "per_page": 0,
  "current_page": 0
}
```

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

### Get Webhook Request API Response (200)

Source: https://api.signly.nl/documentation/index

This snippet shows the JSON response for retrieving a single webhook request (HTTP 200). It includes details about the request, attempts, and responses.

```json
{
  "id": 0,
  "attempts": 0,
  "url": "string",
  "responses": [
    {
      "status_code": 0,
      "message": "string",
      "sent_data": "string",
      "duration": 0.1
    }
  ],
  "succeeded_at": "2019-08-24T14:15:22Z",
  "failed_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
```

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

### Login Response Sample (200 OK)

Source: https://api.signly.nl/documentation/index

This is a sample JSON response for a successful login, containing user information and an authentication token.

```json
{
  "user": {
    "id": 0,
    "name": "string",
    "email": "user@example.com",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "token": "string"
}
```

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

### Get Signable File with Form Data - API Request

Source: https://api.signly.nl/documentation/index

Retrieves the signed file of a signable document, including form data. This requires the `is_sync` parameter to be off and `forms_enabled` to be on. Authentication with an access token is mandatory.

```http
GET /api/signables/{signableId}/{signerId}/file
Host: api.signly.nl
Authorization: Bearer YOUR_ACCESS_TOKEN
```

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

### Get Single Message (JSON Response Sample)

Source: https://api.signly.nl/documentation/index

Displays the JSON structure for a single message retrieved by its ID. This response contains all the details of a specific message, including sender, recipients, content, and status.

```json
{
  "id": 0,
  "attempts": 0,
  "subject": "string",
  "message": "string",
  "extern_id": "string",
  "from": "string",
  "to": [
    "user@example.com"
  ],
  "type": "email",
  "provider": "string",
  "cost": 0.1,
  "cost_type": "string",
  "sent_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
```

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

### Activate Account Response Sample (200 OK)

Source: https://api.signly.nl/documentation/index

This is a sample JSON response for a successful account activation, returning user details and a JWT token.

```json
{
  "user": {
    "id": 0,
    "name": "string",
    "email": "user@example.com",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "token": "string"
}
```

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

### Get Department by ID

Source: https://api.signly.nl/documentation/index

Retrieves a single department by its ID. Requires JWT authorization. Accepts a departmentId path parameter. Returns a 200 status code with department data, 401 if unauthenticated, or 404 if not found.

```HTTP
GET /api/departments/{departmentId}
https://api.signly.nl/api/departments/{departmentId}
```

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

### Register User Response Sample (200 OK)

Source: https://api.signly.nl/documentation/index

This is a sample JSON response after a successful user registration, providing user information and an authentication token.

```json
{
  "user": {
    "id": 0,
    "name": "string",
    "email": "user@example.com",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "token": "string"
}
```

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

### Create Template Request Sample

Source: https://api.signly.nl/documentation/index

This is a sample request body for creating a new template using multipart/form-data. It includes the template name, file, and optional variables and fields.

```json
{
  "name": "string",
  "variables": [
    "string"
  ]
}
```

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

### Get Paginated Messages

Source: https://api.signly.nl/documentation/docs

Retrieves a paginated list of messages. Requires authentication with an access token.

```json
{
    "get": {
        "tags": [
            "Message"
        ],
        "summary": "Message",
        "operationId": "indexMessages",
        "parameters": [
            {
                "name": "page",
                "in": "query",
                "description": "Page number",
                "required": false,
                "schema": {
                    "type": "integer",
                    "format": "int64"
                }
            }
        ],
        "responses": {
            "200": {
                "description": "Paginated messages",
                "content": {
                    "application/json": {
                        "schema": {
                            "$ref": "#/components/schemas/MessagePagination"
                        }
                    }
                }
            },
            "403": {
                "description": "Unauthenticated"
            }
        },
        "security": [
            {
                "access_token": []
            }
        ]
    }
}
```

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

### Get Sign Request Response (200 OK)

Source: https://api.signly.nl/documentation/index

This JSON response details a specific sign request, including its ID, associated emails, credit cost, file deletion status, expiration, cancellation and completion timestamps, state ID, viewer user information, custom field values, and timestamps for creation, updates, and GDPR purging. It also includes arrays of signers and signables associated with the request.

```json
{
  "id": 0,
  "emails": [
    "user@example.com"
  ],
  "credits_cost": 0,
  "files_deleted": 0,
  "expires_at": "2019-08-24T14:15:22Z",
  "cancelled_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z",
  "state_id": 0,
  "viewer_user": {
    "id": 0,
    "name": "string"
  },
  "custom_field_values": [
    {
      "name": "string",
      "value": null
    }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "gdpr_purged_at": "2019-08-24T14:15:22Z",
  "estimated_gdpr_purge_at": "2019-08-24T14:15:22Z",
  "signers": [
    {
      "id": 0,
      "firstname": "string",
      "lastname": "string",
      "fullname": "string",
      "email": "user@example.com",
      "locale": "string",
      "reminder_after": 0,
      "max_reminders": 0,
      "state_id": 0,
      "responded_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "signables": [
    {
      "id": 0,
      "type": 0,
      "name": "string",
      "company_name": "string",
      "description": "string",
      "options": {},
      "state_id": 0,
      "marked_at": "2019-08-24T14:15:22Z",
      "signed_at": "2019-08-24T14:15:22Z",
      "file_deleted_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}
```

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

### Create Template Response Sample

Source: https://api.signly.nl/documentation/index

This is a sample JSON response when a template is successfully created. It returns the details of the newly created template.

```json
{
  "id": 0,
  "name": "string",
  "variables": [
    "string"
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
```

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

### Get Locales

Source: https://api.signly.nl/documentation/docs

Retrieves a list of all available locales supported by the API. This endpoint is useful for internationalization purposes.

```json
{
    "tags": [
        "Locale"
    ],
    "summary": "Locales",
    "operationId": "indexLocales",
    "responses": {
        "200": {
            "description": "All the locales",
            "content": {
                "application/json": {
                    "schema": {
                        "type": "array",
                        "items": {
                            "$ref": "#/components/schemas/Locale"
                        }
                    }
                }
            }
        },
        "401": {
            "description": "Unauthenticated"
        }
    },
    "security": [
        {
            "access_token": []
        },
        {
            "jwt": []
        }
    ]
}
```

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

### Get Recurring Payment Status

Source: https://api.signly.nl/documentation/docs

Fetches the recurring payment status for a company. This endpoint is secured and requires authentication.

```json
{
    "application/json": {
        "schema": {
            "$ref": "#/components/schemas/RecurringPaymentStatus"
        }
    }
}
```

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

### Login Request Sample

Source: https://api.signly.nl/documentation/index

Sample JSON payload for user authentication. Requires email and password, with optional two-factor authentication details.

```json
{
  "email": "string",
  "password": "string",
  "two_factor_code": "string",
  "two_factor_hash": "string"
}
```

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

### Get Signer Verifications - API

Source: https://api.signly.nl/documentation/docs

Retrieves a list of verifications associated with a specific signer. Requires the signer's ID.

```json
{
    "get": {
        "tags": [
            "Signer"
        ],
        "summary": "Verifications",
        "operationId": "indexVerifications",
        "parameters": [
            {
                "name": "signerId",
                "in": "path",
                "description": "Signer ID",
                "required": true,
                "schema": {
                    "type": "integer",
                    "format": "int64"
                }
            }
        ]
    }
}
```

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

### Get User by ID - API

Source: https://api.signly.nl/documentation/docs

Retrieves a specific user's details using their unique ID. Requires authentication.

```json
{
    "get": {
        "tags": [
            "User"
        ],
        "summary": "Get user",
        "operationId": "getUser",
        "parameters": [
            {
                "name": "userId",
                "in": "path",
                "description": "User ID",
                "required": true,
                "schema": {
                    "type": "integer",
                    "format": "int64"
                }
            }
        ],
        "responses": {
            "200": {
                "description": "A single user",
                "content": {
                    "application/json": {
                        "schema": {
                            "$ref": "#/components/schemas/User"
                        }
                    }
                }
            },
            "404": {
                "description": "Not found"
            },
            "401": {
                "description": "Unauthenticated"
            }
        },
        "security": [
            {
                "jwt": []
            }
        ]
    }
}
```

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

### Get Department Details

Source: https://api.signly.nl/documentation/docs

Retrieves details for a specific department using its ID. Requires authentication via access token or JWT.

```json
{
    "tags": [
        "Department"
    ],
    "summary": "Department",
    "operationId": "showDepartment",
    "parameters": [
        {
            "name": "departmentId",
            "in": "path",
            "description": "Department ID",
            "required": true,
            "schema": {
                "type": "integer",
                "format": "int64"
            }
        }
    ],
    "responses": {
        "200": {
            "description": "Single department",
            "content": {
                "application/json": {
                    "schema": {
                        "$ref": "#/components/schemas/Department"
                    }
                }
            }
        },
        "403": {
            "description": "Unauthenticated"
        },
        "404": {
            "description": "Not found"
        }
    },
    "security": [
        {
            "access_token": []
        },
        {
            "jwt": []
        }
    ]
}
```

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

### Get Company Details

Source: https://api.signly.nl/documentation/docs

Retrieves detailed information about a company, including its address. Requires authentication via access token or JWT.

```json
{
    "application/json": {
        "schema": {
            "$ref": "#/components/schemas/CompanyWithAddress"
        }
    }
}
```

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

### Get Users List API

Source: https://api.signly.nl/documentation/docs

Retrieves a list of users. Supports ordering via a query parameter. This endpoint is part of the User resource.

```json
{
    "get": {
        "tags": [
            "User"
        ],
        "summary": "Users",
        "operationId": "indexUsers",
        "parameters": [
            {
                "name": "order",
                "in": "query",
                "description": "Ordering",
                "schema": {
                    "type": "string"
                }
            }
        ]
    }
}
```

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

### Get All Payment Plans

Source: https://api.signly.nl/documentation/docs

Retrieves a list of all available payment plans. Requires JWT authentication. Returns an unauthorized error (401) if not authenticated.

```json
{
    "get": {
        "tags": [
            "Payment plan"
        ],
        "summary": "Payment plans",
        "operationId": "indexPaymentPlans",
        "responses": {
            "200": {
                "description": "All the payment plans",
                "content": {
                    "application/json": {
                        "schema": {
                            "$ref": "#/components/schemas/PaymentPlan"
                        }
                    }
                }
            },
            "401": {
                "description": "Unauthenticated"
            }
        },
        "security": [
            {
                "jwt": []
            }
        ]
    }
}
```

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

### Create User API Request

Source: https://api.signly.nl/documentation/index

This snippet shows the JSON payload for creating a new user via the API. It requires name, email, and password.

```json
{
  "name": "string",
  "email": "user@example.com",
  "password": "pa$$word"
}
```

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

### Add Credits Response Sample

Source: https://api.signly.nl/documentation/index

This is a sample JSON response after successfully adding credits. It usually includes a redirect URL for payment processing.

```json
{
  "redirect_url": "string"
}
```

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

### Get Signers List

Source: https://api.signly.nl/documentation/docs

Fetches a paginated list of signers associated with a specific sign request. Supports filtering, sorting, and pagination. Requires authentication.

```json
{
    "tags": [
        "Signer"
    ],
    "summary": "Signers",
    "operationId": "indexSigners",
    "parameters": [
        {
            "name": "signRequestId",
            "in": "path",
            "description": "Sign request ID",
            "required": true,
            "schema": {
                "type": "integer",
                "format": "int64"
            }
        },
        {
            "name": "page",
            "in": "query",
            "description": "Page",
            "schema": {
                "type": "integer",
                "format": "int64"
            }
        },
        {
            "name": "limit",
            "in": "query",
            "description": "Limit, max 250",
            "schema": {
                "type": "integer",
                "format": "int64"
            }
        },
        {
            "name": "order",
            "in": "query",
            "description": "Ordering",
            "schema": {
                "type": "string"
            },
            "example": "id,desc"
        },
        {
            "name": "filters",
            "in": "query",
            "description": "\n    Available fields:\n    - id\n    - firstname\n    - lastname\n    - email\n    - reminder_after\n    - max_reminders\n    - locale\n    - created_at\n    - updated_at\n    ",
            "schema": {
                "type": "array",
                "items": {
                    "$ref": "#/components/schemas/Filtering"
                }
            }
        }
    ],
    "responses": {
        "200": {
            "description": "A paginated list with signers",
            "content": {
                "application/json": {
                    "schema": {
                        "$ref": "#/components/schemas/SignerPagination"
                    }
                }
            }
        },
        "401": {
            "description": "Unauthenticated"
        },
        "404": {
            "description": "Not found"
        }
    },
    "security": [
        {
            "access_token": []
        }
    ]
}
{
    "tags": [
        "Signer"
    ],
    "summary": "Create a signer"
}
```

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

### Create Access Token

Source: https://api.signly.nl/documentation/index

Creates a new access token with a specified name and description. Requires JWT authorization. The response includes the newly created token.

```HTTP
POST /api/access-tokens
https://api.signly.nl/api/access-tokens
```

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

### Get Single Message by ID

Source: https://api.signly.nl/documentation/docs

Retrieves a specific message by its ID. Requires authentication with an access token. Returns the message details or a 404 if not found.

```json
{
    "get": {
        "tags": [
            "Message"
        ],
        "summary": "Message",
        "operationId": "showMessage",
        "parameters": [
            {
                "name": "MessageId",
                "in": "path",
                "description": "Message ID",
                "required": true,
                "schema": {
                    "type": "integer",
                    "format": "int64"
                }
            }
        ],
        "responses": {
            "200": {
                "description": "Single message",
                "content": {
                    "application/json": {
                        "schema": {
                            "$ref": "#/components/schemas/Message"
                        }
                    }
                }
            },
            "403": {
                "description": "Unauthenticated"
            },
            "404": {
                "description": "Not found"
            }
        },
        "security": [
            {
                "access_token": []
            }
        ]
    }
}
```