Troubleshooting

The Knox Deployment Program (KDP) API uses HTTP response codes to indicate the success or failure of a request. A 2XX response code indicates success, a 4XX response code indicates a client-side error due to the request inputs, and a 5XX response code indicates a server-side error.

Additionally, JSON error responses include a KDP-specific error code and supporting data.

Standard HTTP error codes

The following table lists common HTTP status codes returned by the KDP API:

The error object

Error responses include an error object, which has the the following attributes:

KDP error codes

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

Common error responses

Failure reported within device transaction status

The following example is a 200 OK response for List device transaction status, but includes a transaction-specific error. In this particular scenario, the specified device is invalid, so you need to provide the correct IMEI and reupload it.

      {
        "devices": {
          "totalCount": 1,
          "totalPage": 1,
          "pageNum": 0,
          "transactions": [{
            "transactionId": "246903",
            "state": "Complete",
            "type": "Put",
            "operationType": "UPLOAD",
            "devices": [{
              "imei": "35182611....643",
              "code": 40000004,
              "message": "DEVICE_INVALID",
              "data": "The specified device is not valid."
            }]
          }]
        }
      }

Customer ID is invalid

If the customer ID you provided while uploading devices is incorrect, you will get a 400 Bad Request status with an error response resembling the following JSON. Ask the customer to provide you with their correct customer ID (which can be found by clicking on their profile icon on their Samsung Knox account), and try reuploading the device.

        {
            "errorId": "8B29A680442642C98D1AAF0ADD4733CF",
            "code": 40000011,
            "message": "CUSTOMER_ID_INVALID",
            "data": "The specified customer ID is not valid."
        }

Unauthorized requests

For any endpoint, if your access token has expired then you will get a 401 Unauthorized error, along with a brief JSON message. Simply get a new access token, and use the new token as the Authorization header value in your KDP API calls.

        {
            "error": "Invalid authentication token"
        }

Invalid reseller ID

If the reseller ID you’ve provided is incorrect (for instance, while retrieving a list of your customers), you will get an error resembling the following. Use the correct reseller ID, which can be found from the KDP dashboard, and try again.

        {
            "errorId": "6C8B29A65F7845BC8ECD174F4D8B29A6",
            "code": 40000010,
            "message": "RESELLER_ID_INVALID",
            "data": "The specified reseller ID is not valid."
        }

Internal server errors

Server errors will return a 500 Internal Server Error status, and an error message resembling the following. If you get a server error, try again later.

        {
            "errorId": "6C989F5B5F7845BC8ECD174F4D91D192",
            "code": 50000000,
            "message":"INTERNAL_SERVER_ERROR",
            "data": "An unknown internal server error has occurred."
        }