Errors

Whenever Naurt returns a non-2XX response code, it will return an error message of the following format

JSON

{
    "code": String,
    "reason": String,
    "remediation": String
}

An example might be

JSON

{
    "code":"E-001-005",
    "reason":"`Authorization` header must be present",
    "remediation":"Add an `Authorization` header with your API key from the Naurt dashboard"
}

This will give you instant feedback on any issues encountered, and usually the steps required to fix that issue. Please review the remediation steps closely, if you are unable to resolve the issue, please contact Naurt support, and include the original request, the error code and what remediations you have already attempted.

Error codes are of the format E-XXX-XXX. The first part, E-XXX can be used to find the product. The second part identifies the particular error. The error code to products are as follows

E-000 - General global errors
E-001 - API Key errors
E-002 - Final Destination V1 errors
E-003 - Final Destination V2 errors
E-006 - Feedback V1 Errors

You may use the following tables to lookup error codes

E-000 (General Global Errors)

Code	Reason	Remediation	Status code
E-000-000	Internal Server Error	Contact Naurt Support if error persists	500
E-000-001	Internal Server Error	Contact Naurt Support if error persists	500
E-000-002	Internal Server Error	Contact Naurt Support if error persists	500
E-000-003	Internal Server Error	Contact Naurt Support if error persists	500
E-000-004	Internal Server Error	Contact Naurt Support if error persists	500
E-000-005	Internal Server Error	Contact Naurt Support if error persists	500
E-000-006	Internal Server Error	Contact Naurt Support if error persists	500
E-000-007	Not found	Check documentation for valid endpoints	404
E-000-008	Unprocessable Content	Check documentation; most likely your JSON body does not match the specification	422

E-001 (API Key Errors)

Code	Reason	Remediation	Status code
E-001-000	Key not recognised	Verify provided API key matches key on dashboard	401
E-001-001	Key is paused	Unpause key	403
E-001-002	Key is deleted	Use a different key; keys can not be undeleted	403
E-001-003	Key is disabled	Naurt has disabled your key; please contact Naurt support	403
E-001-004	This request would take you over your allowance. Your package allows {} queries, your key currently has {} and the request has {} queries	Upgrade your package; contact sales	402
E-001-005	`Authorization` header must be present	Add an `Authorization` header with your API key from the Naurt dashboard	400

E-002 (Final Destination V1 Errors)

Please note that Final Destination V1 is a legacy software - if you are considering integrating for the first time, please use V2. V1 may sometimes use errors from V2, so also check those (in this case, the error code will start with E-003)

Code	Reason	Remediation	Status code
E-002-000	latitude present without longitude or vice-versa	When using a location search, always include both latitude and longitude	400
E-002-001	Search country support is not finalised	Verify country code is supported. Check search country against coverage maps.	400
E-002-002	`verbose` or `pretty_print` at query level in bulk request	Remove all instances of `verbose` or `pretty_print` from individual queries in the bulk request	400

E-003 (Final Destination V2 Errors)

Code	Reason	Remediation	Status code
E-003-000	Search country support is not finalised	Verify country code is supported. Check country against coverage maps.	400
E-003-001	Subceeded minimum allowed queries. Minimum allowed queries: 1	You included {} queries: increase count to minimum allowed or above	400
E-003-002	Exceeded maximum allowed queries. Maximum allowed queries: 200	You included {} queries: decrease count to maximum allowed or below	400
E-003-003	Mixed `id` with other search parameters	Remove `id` or other search parameters	400
E-003-004	Mixed `source_id` with other search parameters	Remove `source_id` or all other search parameters	400
E-003-005	Not enough search parameters present to make a valid query	Provide more search parameters. See documentation for details on search modes	400
E-003-006	Unsupported `source_id` parameter	See documentation for currently supported `source_id` values	400
E-003-007	Can not search by `address_string` and `address_structured` at the same time	Search by only `address_string` or `address_structured` in a single query	400
E-003-008	`address_structured` does not contain enough data to form a fully qualified address	Include more fields in the `address_structured` JSON. Must contain at a minimum: a postal code, a street name, and a street number or a house name	400
E-003-009	`address_line` overlaps with other fields	When using `address_line` in the structured address you may not also use `unit`, `house_name`, `street_number`, `street_name`. Review documentation on intended use	400
E-003-010	Invalid location provided	Locations must be valid WGS84 coordinates in decimal degrees. Latitudes must be between -90.0 and 90.0 and longitudes must be between -180.0 and 180.0.	400
E-003-011	`distance_filter` invalid. Must be between {} and {}. You provided {}.	Ensure `distance_filter` is between acceptable values	400
E-003-012	`language` may only be used in a reverse geocode	Either remove `language` or perform a reverse geocode	400
E-003-013	Attempt to search by multiple `source_id`	Ensure only searching by a single `source_id` at a time	400

E-006 (Feedback Errors)

Code	Reason	Remediation	Status code
E-006-000	Missing Naurt ID or location and address	Added either a Naurt ID or an address with location. Review documentation for correct input parameters	400
E-006-001	Bad address	Address string must be 5-200 characters and include comma or space separated words	400
E-006-002	Address only	Add a Naurt ID, location or both	400
E-006-003	Location only	Add a Naurt ID, address string or both	400
E-006-004	Naurt ID only	Add a location, address string or both	400
E-006-005	Invalid location	Locations must be valid WGS84 coordinates in decimal degrees. Latitudes must be between -90.0 and 90.0 and longitudes must be between -180.0 and 180.0.	400
E-006-006	Latitude without longitude, or vice versa	Ensure all latitudes are paired with longitudes, and vice versa	400

QuickstartCoverage

QuickstartJSON Specification