500

0.0.1

Unhandled error has occurred.

500

0.0.2

Mandatory attribute is missing. Request is malformed, please consult the API documentation.

500

0.0.3

Missing system default configuration. Client service is not properly setup, please notify product support team for checking the configuration.

500

0.0.4

Attribute size exceeded. A request attribute is larger than what is supported, please adjust your API request.

500

0.0.5

E-mail could not be sent.

500

0.0.6

Error occurred when validating the request parameters. Please check the request to adjust the faulty parameter.

409

0.0.7

Information already exists in the system. Please check if the externalRef parameter is being reused from an older request.

429

Too many request. Please check how many parallel requests are being sent.

401

1.1.0

Invalid license or not present. The client service that is trying to be used is not valid.

401

1.1.1

License is inactive. Client service or issuer account is inactive, please contact product support team for activation.

409

1.1.2

Client service for license already exists. Please contact support team to check license configuration.

409

1.1.3

Client service is in a status that does not allowed the requested operation. Please check if client service is inactive, and if so activate it or contact product support team.

400

1.1.4

Client service credential is too weak. The client service secret defined is too weak and not acceptable.

403

1.2.0

Issuer is inactive. Please contact support team to check configuration.

403

1.3.0

Partner is inactive. Please contact support team to check configuration.

409

2.1.0

Certificate not configured or in invalid state. Please access the backoffice and check if the certificate configuration procedure was properly executed.

409

2.1.1

DocumentRequest consult and delivery is not covered for this issuer's plan. The API request being made is requesting more functionalities than the ones subscribed for the issuer account.

This can occur when the plan subscription is of type “Basic”, and the API request is trying to (at least of the following):

• Request a previous signed document or use any of the consult API functions;

• Delivery of a signed document copy to an e-mail using the signRequest.preservationInfo.deliveryInfo structure. The signRequest.preservationInfo structure must not exist for “Basic” subscriptions.

409

2.1.2

DocumentRequest preservation is not covered for this issuer's plan. The API request being made is requesting more functionalities than the ones subscribed for the issuer account.

This can occur when the plan subscription is of type “Basic”, and the API request is trying to archive/preserve the document using the signRequest.preservationInfo structure. This structure must not exist for “Basic” subscriptions.

409

2.1.3

DocumentRequest action is not covered for the issuer's plan. The API request being made is requesting more functionalities than the ones subscribed for the issuer account.

Please contact support team for further details.

409

2.2.0

DocumentRequest content-type is not valid for the requested signature type. Please check the if APIrequest attribute signRequest.documents[].contentType matches the supported options stated in signRequest.documents[].signatureInfo.signatureType.

Available options described in Swagger API documentation.

409

2.2.1

Visible elements not present for PAdES Signature. Insuficcient information is being presented in the API request for applying a visible digital signature on a PDF document.

409

2.2.3

Insufficient delivery information. A document delivery is being request by filling in the API signRequest.preservationInfo.deliveryInfo, but no valid e-mail address is being presented in signRequest.preservationInfo.deliveryInfo[].personReceiver.email.

409

2.2.4

External reference already exists in the system. The reference should be unique and no reusages of old references can be used (including references for requests has returned errors).