Error Handling in eSign WYSIWYS¶
Merchant-APIs¶
The term Merchant-APIs includes both versions of the /signdoc and /convert APIs:
- /signdoc/pades
- /signdoc/convert
- /v1/signdoc/pades
- /v1/signdoc/convert
All of these APIs use standard HTTP response codes to communicate the result of a request.
Unfortunately it is currently not possible to provide more information in case of errors because of backwards-compatibility of the API.
Error Responses / HTTP Status Codes¶
For a detailed breakdown of possible responses on a per-request-basis see the relevant API documentations: - /signdoc/pades - /signdoc/convert - /v1/signdoc/pades - /v1/signdoc/convert
How to Fix Errors? What to Do?¶
How to react to errors depends mostly on the category of the HTTP status code.
HTTP 401 & 403
Use the correct token and authentication data and try again. If the problem persists, contact BankID support.
HTTP 400 - returning error message
This is a request validation error because of missing or invalid parameter values. Fix the request according to the error message and try again. If the problem persists, contact BankID support.
HTTP 400 - returning JSON object
This is a PDF validation error. Either the PDF document(s) themselves or in combination with the request parameters given cannot be used for signing.
See the response field conversionErrors for details. Note that this is done on a per-document-level.
Modify the PDF(s) and/or request parameters to make them fit fo signing. If the problem seems "wrong" or unsolvable contact BankID support.
HTTP 5xx
Technical problems, contact BankID support.
WYSIWYS (UI and Backend)¶
The BankID eSign WYSIWYS workflow communicates errors to the user that is signing through the UI. It uses error codes and error references that will help to identify what caused the problem when contacting BankID support.
Error code: Error code classifying the problem (see table below).
Error reference: Unique reference to a particular error occurrence - please state this when contacting BankID support
Error Codes¶
| Error Code | Description | Category | Quick Fix / Remark |
|---|---|---|---|
| SIG-FE201 | Sign order ID not found | Document / data errors | |
| SIG-FE202 | Document fetch succeeded but content is corrupt/empty | Document / data errors | Try to refresh the browser |
| SIG-FE203 | PDF failed to render | Document / data errors | Try to refresh the browser |
| SIG-FE204 | Download could not be started or completed | Document / data errors | |
| SIG_WB200 | Problem loading document | Document / data errors | |
| SIG-FE301 | User session expired | Client and user errors | Merchant needs to create a new sign order |
| SIG-FE303 | Signing failed for other reasons | Client and user errors | |
| SIG-FE304 | Attempt to sign when already completed | Client and user errors | |
| SIG_WB300 | No consent given during login | Client and user errors | User did not consent to data use - cannot continue |
| SIG_WB301 | BankID login error | Client and user errors | Error during login - could be cancelled, wrong password etc. |
| SIG-FE401 | Client/server markup mismatch | Technical errors | Try to refresh the browser |
| SIG-FE402 | Double submit | Technical errors | Try to refresh the browser |
| SIG_WB500 | Internal error | Signing errors | |
| SIG_WB501 | Internal error | Signing errors | |
| SIG_WB502 | Internal error | Signing errors | |
| SIG_WB503 | Internal error | Signing errors | |
| SIG_WB504 | Internal error | Signing errors | |
| SIG_WB505 | Internal error | Signing errors | |
| SIG_WB506 | Internal error | Signing errors | |
| SIG_WB507 | Internal error | Signing errors | |
| SIG_WB508 | Internal error | Signing errors | |
| SIG_WB509 | Internal error | Signing errors | |
| SIG_WB506 | Internal error | Signing errors | |
| SIG_WB600 | Internal error | Validation errors | |
| SIG_WB601 | Internal error | Validation errors | |
| SIG_WB602 | Internal error | Validation errors | |
| SIG_WB603 | Internal error | Validation errors | |
| SIG_WB604 | Internal error | Validation errors | |
| SIG_WB605 | Internal error | Validation errors | |
| SIG_WB700 | Internal error | Timestamping errors | |
| SIG_WB701 | Internal error | Timestamping errors | |
| SIG_WB702 | Internal error | Timestamping errors | |
| SIG-FE999 | Internal error | Fallback errors | |
| SIG_WB999 | Internal error | Fallback errors |
How to Fix Errors? What to Do?¶
How to react to errors depends mostly on the category of the error. See the 'Quick Fix' column for possible error-specific things that might help to fix the problem.
Category 'Document / data errors'
The category contains data inconsistencies as well as some client-side browser problems. If no quick fix is given or if the problem persists, contact BankID support.
Category 'Client and user errors'
This category holds mostly errors that result from user decisions (SIG_WB300 & SIG_WB301) or need fixing from the merchant side (SIG-FE301). For the remaining technical issues contact BankID support.
Category 'Technical errors'
The category consists of client side and communication problems. If the quick fix does not help, contact BankID support.
Category 'Signing errors'
These are all internal errors that can occur during the signing process. If the problem persists, contact BankID support.
Category 'Validation errors'
These are all internal errors that can occur during the signing process. If the problem persists, contact BankID support.
Category 'Timestamping errors'
These are all internal errors that can occur during the timestamping process. If the problem persists, contact BankID support.
Category 'Fallback errors'
These are general client and server side errors. If the problem persists, contact BankID support.