Errors

The zkPass RESTful API strives to provide a smooth user experience, but occasionally errors may occur. This section equips you with knowledge about potential error responses you might encounter.

Error Response

{
    "status": [http_status_code],
    "status_code": [status_code],
    "status_text": [error_message]
}

HTTP Status Code	Status Code	Error Message	Description
400	INVALID_PARAMS	Invalid parameter(s).	The provided parameters don't meet the required format or validation rules for the app input
400	INVALID_PARAMS	Error serializing parameters	Our system failed to convert the provided parameters into the required format
404	INVALID_URL	Invalid URL	The requested privacy app endpoint or resource was not found in our system
500	ERROR_LOADING_APP	Something went wrong. Contact the administrator if the error persists	Our system failed to initialize or load the requested privacy app
500	ERROR_LOADING_INSTANCE	Something went wrong. Contact the administrator if the error persists	Our system failed to create a new instance of the privacy app
500	CUSTOM_ERROR	[Custom message]	A specific error occurred that requires custom handling (message varies)
500	MISSING_APPS_CONFIG	Something went wrong. Contact the administrator if the error persists	The required configuration for privacy apps is not found or inaccessible
500	ERROR_LOCKING_SOCKET	Something went wrong. Contact the administrator if the error persists	Our system failed to establish exclusive access to the communication socket
500	ERROR_SENDING_TO_SOCKET	Something went wrong. Contact the administrator if the error persistsrver is not ready yet, please try again later	Our system failed to send data through the communication socket
500	ERROR_RECEIVING_FROM_SOCKET	Something went wrong. Contact the administrator if the error persists	Our system failed to receive data from the communication socket
500	ERROR_DESERIALIZING	Something went wrong. Contact the administrator if the error persists	Our system failed to parse the output data from the privacy app