Skip to main content
When a client contacts the CheckLists service via the API, situations may arise when the service or search registers used by the service are unavailable. To correctly process these situations, you need to know the following. In response to the request, the service returns an HTTP status response. Analyzing it and the structure of the response, the following situations in the service’s operation can be distinguished:
  • HTTP status with a code in the range 500-599 - the CheckLists service is unavailable or is not working correctly
  • HTTP status with a code in the range 400-499 - the CheckLists service is available, but cannot process your request. In the response, instead of the structure described above, the client will receive the following structure with a description of the error:
  • error int
  • message string
List of errors:
messageerror
User “user” does not exist.ACCOUNT_NOTFOUND = 1;
Address “ip address” is not in the list of allowed ones.NOT_ALLOW_IP = 2;
Test (promotional) access: request limit has been exhausted or the validity period has expired.TEST_ACCESS_END = 3;
User “user” is allowed access only through the web resource.SITEONLY = 6;
The start date of using the service “start date” has not yet arrived.ACCOUNT_NOT_ALLOWED_YET = 7;
“end date” the allowed period of using the service has expired.ACCOUNT_ACCESS_ENDS = 8;
User “user” is blocked.ACCOUNT_BLOCKED = 9;
User “user” did not confirm registration.ACCOUNT_NOT_CONFIRM = 10;
The request limit (“request limit”) has been exhausted.ACCOUNT_REQUEST_LIMIT_ENDS = 11;
The ‘Start date’ parameter for checking changes in the Unified State Register of Individual Entrepreneurs and Sole Proprietors is not specified correctlyREQUEST_BEGINDATE_ERROR = 103;
The ‘End date’ parameter for checking changes in the Unified State Register of Individual Entrepreneurs and Sole Proprietors is not specified correctlyREQUEST_ENDDATE_ERROR = 104;
The lower limit entry parameter lowranklimit for searching the sanctions list database is not specified correctly.REQUEST_LOWRANKLIMIT_ERROR = 105;
  • HTTP status with code 200 - the CheckLists service is available and can process requests from clients. The response structure may vary depending on access to search registers.
  • the search register you are accessing is working, you have access to it, and the request processing does not exceed the time allocated for this - the service always returns the result (the structure described above in the text, or an empty array in case of no matches)
  • otherwise, in the response block for this search register, instead of the response structure, the client may receive a text message with an error. List of these messages and situations in which they appear:
  • “9000.No connection to the service” - The search registry is not working or the service is not connected to it
  • “9001.Access to the service is prohibited” - Access to the search registry is prohibited, as it is not included in the package of services that you paid for
  • “9003.Request processing exceeds the time allocated for this. Specify the request” - occurs when processing a request to the search registry exceeds the time allocated for this
  • “9004.No connection to the service database” - occurs when the service that serves the registry is available, but there is no connection to the registry database