Request quotas
Requests to specific API endpoints consume quotas that are assigned to your account by the company administrator. These quotas are the same for both the API requests and operations via the notary console. When reaching a quota, a request fails and the API returns a response with the 402 code and the body containing the following JSON object:
{
"message": "Quota limit reached",
"quota": {
"name": "notarizations",
"quota": 1000,
"overage": 100,
"usage": 1100
}
}
Here is the summary of what quotas the API consumes.
Quota name |
Quota description |
Endpoints (with methods) that use this quota |
---|---|---|
Notary storage |
The amount of space in the dedicated storage that can be used by files uploaded to this storage via the API or the notary console. |
POST /stored-files POST /stored-files/sign POST /templates |
Notarizations |
The number of notarizations that can be triggered via the API or the notary console. |
POST /stored-files POST /files POST /meta POST /s3 POST /hashes |
eSignatures |
The number of electronic signatures that can be triggered via the API or the notary console. |
POST /documents/{doc_id}/signees |
Document templates |
The number of the e-sign document templates that can be created via the API or the notary console. |
POST /templates |