Skip to main content
You can tell if your request was successful by checking the status code when receiving an API response. If a response comes back unsuccessful, you can use the error type and error message to figure out what has gone wrong and do some rudimentary debugging (before contacting support).

Before reaching out to support with an error, please be aware that 99% of all reported errors are, in fact, user errors. Therefore, please carefully check your code before contacting CUFinder support.

Status codes

See every HTTP status code the API returns, what each one means, and how to resolve it.

​
The error envelope

Whenever a request fails, the API returns "success": false with a machine-readable error.code, a human-readable message, and, on validation errors, a details array naming each problem field:
Handle errors by branching on the success flag and error.code; both are stable. Note that a not-found lookup returns HTTP 200 with "success": false, so the HTTP status alone is not enough. The message text is for humans and may change.

​
Error codes

​
401
Your API key is missing or invalid. Check the x-api-key header.
​
402
Your account does not have enough credits. Nothing was charged and no work was performed.
​
200
The entity you addressed could not be resolved. Returned with HTTP 200 and "success": false, check the envelope, not the status code. An empty search result is not an error; searches return "success": true with an empty array.
​
408
The upstream lookup timed out. You were not charged, retry the request.
​
422
The request is missing required parameters or has invalid values. See error.details for the exact fields.
​
429
Too many requests. Slow down and retry later.
​
400
The request itself is malformed (for example, invalid JSON).
​
500
Something went wrong on our side. Credits are never charged for failed requests.