All the knowledge you need
Here you can find some advice to consider to approach this API. If you prefer, we provide code samples, OAS3 documentation, the ability to try the API live via the Swagger UI or import the entire collection into Postman. We also offer a Sandbox environment where you can experiment with all kinds of requests completely free of charge.
Useful tips to start with
esignature
Get the token in the appropriate section before you start.
Use the the online tool or generate it via API. Set the expire date, a usefull name and now add a bunch of scopes to limit the possible actions your token can do.
Get your Certificate
Use the following endpoints to obtain a signature certificate to digitally sign your files:
This endpoint allows you to obtain a new certificate.
The respone will contains a link by the registration authority to verify the identity and generate the certificate.
Once the procedure is complete the user will receive the credentials to sign using the certificate.
Since this could be a one-time operation you may prefer contact our team to get more information or to obtain the certificate manually.
This endpoint returns a list of certificates. The list can be filtered by state and certificate type.
This endpoint returns the details about a certificate.
Get you first certificate
POST /certificates/namirial-automaticThis endpoint allows you to obtain a new certificate.
The respone will contains a link by the registration authority to verify the identity and generate the certificate.
Once the procedure is complete the user will receive the credentials to sign using the certificate.
Since this could be a one-time operation you may prefer contact our team to get more information or to obtain the certificate manually.
Get a list of owned certificates
GET /certificatesThis endpoint returns a list of certificates. The list can be filtered by state and certificate type.
Get certificate details
GET /certificates/{id}This endpoint returns the details about a certificate.
Make your first E-Signature
Use the following endpoints to manage electronic signatures:
This endpoint allows you to create a QES Signature using a Massive Automatic Certificate.
Input your document and the certificate credentials to sign the document.
The response will contain the signature details. Take the {id} and...
The output will be the signed document.
Get a list of signatures
GET /signatures
This endpoint returns a list of signatures. The list can be filtered by state, certificate type, and signature type.
Get signature details
GET /signatures/{id}/{actionType}
This endpoint returns the detail, audit, the signedDocument or the validatedDocument of a signature.
Create your first QES Signature
POST /EU-QES_automaticThis endpoint allows you to create a QES Signature using a Massive Automatic Certificate.
Input your document and the certificate credentials to sign the document.
The response will contain the signature details. Take the {id} and...
Download the signed document
GET /signatures/{id}/signedDocumentThe output will be the signed document.
Get a list of signatures
GET /signatures
This endpoint returns a list of signatures. The list can be filtered by state, certificate type, and signature type.
Get signature details
GET /signatures/{id}/{actionType}
This endpoint returns the detail, audit, the signedDocument or the validatedDocument of a signature.
- Oas file url https://alpha.console.openapi.com/oas/en/esignature.openapi.json
- Production domain alpha.esignature.openapi.com
- Sandbox domain alpha.esignature.openapi.com
-
Production Scopes 11
- POST alpha.esignature.openapi.com/EU-QES_automatic
- GET alpha.esignature.openapi.com/signatures
- POST alpha.esignature.openapi.com/certificates
- GET alpha.esignature.openapi.com/certificates
- POST alpha.esignature.openapi.com/verify
- POST alpha.esignature.openapi.com/EU-QES_otp
- POST alpha.esignature.openapi.com/EU-QES_eseal
- DELETE alpha.esignature.openapi.com/signatures
- POST alpha.esignature.openapi.com/EU-SES
- PATCH alpha.esignature.openapi.com/certificates
- POST alpha.esignature.openapi.com/EU-QES_otp_sessions
-
Sandbox Scopes 11
- POST alpha.esignature.openapi.com/EU-QES_automatic
- GET alpha.esignature.openapi.com/signatures
- POST alpha.esignature.openapi.com/certificates
- GET alpha.esignature.openapi.com/certificates
- POST alpha.esignature.openapi.com/verify
- POST alpha.esignature.openapi.com/EU-QES_otp
- POST alpha.esignature.openapi.com/EU-QES_eseal
- DELETE alpha.esignature.openapi.com/signatures
- POST alpha.esignature.openapi.com/EU-SES
- PATCH alpha.esignature.openapi.com/certificates
- POST alpha.esignature.openapi.com/EU-QES_otp_sessions
Redoc missing.