This version of the API docs is depreciated and will be taken offline soon.
Please migrate to the new version as soon as possible to avoid service disruption.
New version can be found at https://docs.wceaapi.org/
Verified uses conventional HTTP response codes to indicate success or failure of an API request.
In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information, and codes in the 5xx range indicate an error with Verified's servers.
Not all errors map cleanly onto HTTP response codes, however. And sometimes the same error code can be returned for multiple reasons.
Whenever a HTTP error response is returned, the payload contains more information about the error. This should help in diagnosing the cause of the error.
HTTP Status Code Summary
- 200 OK
- Everything worked as expected.
- 201 Created
- A new resource was created succesfully.
- 400 Bad Request
- Often missing a required parameter.
- 401 Unauthorized
- Invalid or missing authentication params.
- 404 Not Found
- The requested item doesn't exist.
- 500 Internal Server Error
- Something went wrong on Verified's end.
Anatomy of an error payload
{
"_meta":{ //metadata container
"status":"ERROR",
"count":1
},
"records":{ //payload container
"errorCode":401, //HTTP Code
"userMessage":"Unauthorized.", //HTTP Message
"devMessage":"Something wrong", //Reason for error
"more":"", //Where to obtain more information
"applicationCode":"" //Internal app code
}
}