Error codes

The Knox Guard API uses the conventional HTTP response code to indicate the success or failure of a request. A 2XX response code indicates success, a 4XX response code indicates an error given the inputs of the request, and a 5XX response code indicates a failure with the Knox Guard platform. In addition, errors contain a JSON response body with more information about the error:

HTTP/1.1 200 OK Content-Type: application/json

{
    "result" : "SUCCESS",
    objectId" : "SDAKJ23DKCMSDAKENXSSAEQ",
    "requestedId": "111000291332456"
}

Async result : POST /kcs/v1.1/kg/transaction

HTTP/1.1 200 OK Content-Type: application/json

{
    "count" : 3,
    "success": 2,
    "fail": 1,
    "resultList": [
        {
            "result": "FAIL",
            "requestedId": "123456789012347"
            "error" : {
                "code" : "4000000",
                "message" : "RESOURCE_INVALID_PARAM",
                "reason" : "RESOURCE_INVALID_PARAM"
            }
        }
    ]
}

HTTP/1.1 401 Unauthorized Content-Type: application/json

{
    "result" : "FAIL",
    "error" :
    {
        "code": 4010000,
        "message": "AUTHORIZATION_FAIL",
        "reason": "Invalid Api Key"
    }
}

Error response body

The error response attributes are:

Error object

The error objects contain the following attributes:

Standard HTTP error codes

The following table lists the most common HTTP error responses:

Knox Guard error codes

Knox Guard specifies several custom error codes which provide more information than the standard HTTP error response codes. The following table lists the standard Knox Guard error codes and their descriptions: