This guide explains how to track and manage your consumption of Yousign services, including eSignatures, eSeals, and document archiving, to help you stay in control of your usage and optimize your subscription.

Understanding your consumption

In this section, we break down the key concepts behind how consumption is tracked across various Yousign services.

• For Simple and Advanced eSignatures, consumption is measured by the number of invited signers. Signers are counted when the request is sent, regardless of whether they complete the signature.

  📘

  The number of invited signers for Qualified eSignatures is also provided, but this is for informational purposes only.

• For Qualified eSignatures, consumption is measured by the number of identification attempts made by your signers, whether successful or failed. There are two distinct modes of identification:
  • Signers are identified by a double identity verification (identity document and video verification).
  • Signers can also be identified by using their saved identity after an initial identity verification.
• For Simple and Advanced eSeals, consumption is measured by the number of documents sealed.
• For document archiving, consumption is tracked by the cumulative size of archived documents (in MB).

Track your overall consumption

You can monitor your consumption over a specified period for each of Yousign’s services.

To do so, use the GET /consumptions/detail endpoint and specify the desired date range.

The response will provide your organization’s consumption for each Yousign service (including signature and seal levels, identity verifications for QES, and document archiving). The data is returned as an array, detailing:

• Source (app or api, based on request origin),
• Type of consumption (invited_signers for Simple and Advanced eSignatures, identification_attempts for Qualified eSignatures, electronic_seals for eSeals, and archiving for document archiving),
• Level (simple, advanced, or qualified).

You can also retrieve detailed consumption by workspace or filter the results to show data for specific workspaces only, as detailed in the API Reference.

{
    "meta": {
        "next_cursor": null,
        "updated_at": "2024-09-13T14:16:54+00:00"
    },
    "data": [
        {
            "source": "api",
            "workspace_id": "b97af75b-06e9-468c-8104-31fa737fdf9f",
            "type": "invited_signers",
            "level": "simple",
            "value": 150,
        },
        {
            "source": "api",
            "workspace_id": "b97af75b-06e9-468c-8104-31fa737fdf9f",
            "type": "invited_signers",
            "level": "advanced",
            "value": 50,
        },
        {
            "source": "api",
            "workspace_id": "6eb23128-8e62-4ce7-a366-0664bbdaefc8",
            "type": "electronic_seals",
            "level": "simple",
            "value": 10,
        },
    ]
}

Track add-on consumption

If you have subscribed to add-ons (such as eSignatures or eSeals), it’s helpful to track your usage against the quota provided in your package.

To do this, use the GET /consumptions/addons endpoint. This will give you a list of all active add-ons your organization has subscribed to, along with their start and end dates, total available quota, and current consumption levels.

You can also filter results by a specific add-on, as detailed in the API Reference.

{
	"data": [
		{
			"name": "electronic_signature",
			"start_at": "2024-01-01T22:59:00Z",
			"end_at": "2025-01-17T22:59:00Z",
			"quota": 1000,
			"consumed": 150
		},
				{
			"name": "advanced_electronic_signature",
			"start_at": "2024-01-01T22:59:00Z",
			"end_at": "2025-01-17T22:59:00Z",
			"quota": 500,
			"consumed": 50
		},		
		{
			"name": "electronic_seal",
			"start_at": "2024-01-01T22:59:00Z",
			"end_at": "2025-01-17T22:59:00Z",
			"quota": 500,
			"consumed": 10
		}
	]
}

Please note that this endpoint is not available in the Sandbox environment, as add-ons are only used for production usage.

Track the consumption via the Yousign application

Additionally, you can track your consumption by logging into the Yousign application and navigating to the Consumption page.

Learn more about the Consumption Dashboard here.