API Errors
The Upvest Investment API uses standard HTTP status codes and RFC9457 error types.
Error payloads
Error payloads have a consistent format, expressing problem details according to RFC9457.
The content-type
for all error messages is application/problem+json
and not application/json
as for all other responses.
Example error response
HTTP/1.1 401 Unauthorized
content-length: 174
content-type: application/problem+json
date: Mon, 11 Oct 2021 10:42:01 GMT
upvest-request-id: afcd3c2f-6965-4e1b-bb3e-87a3b481ce29
{
"detail": "Signature is incorrect",
"request_id": "afcd3c2f-6965-4e1b-bb3e-87a3b481ce29",
"status": 401,
"title": "Unauthorised",
"type": "https://docs.upvest.co/errors/unauthorised"
}
Error fields
detail
: A human-readable description of the specific error.instance
: This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.request_id
: Correlation ID for the original request.status
: Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.title
: A short, human-readable title for the general error type; the title should not change for given types.type
: URL to a document describing the error condition.
HTTP responses codes
Response codes in the range 2xx indicate a successful response, in the range 4xx a client error and in the range 5xx a server error.
In the subchapters you will find the exact error descriptions and possible solutions for the Upvest-specific error types.
Was this page helpful?