Errors

In this guide, we will talk about what happens when something goes wrong while you work with the API. Let's look at some status codes and error types you might encounter.

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).


Status codes

Here is a list of the different categories of status codes returned by the Addressfully API. Use these to understand if a request was successful.

  • Name
    200
    Description

    The request was successful and the address lookup data is returned.

  • Name
    400
    Description

    The request is malformed or missing required parameters. This occurs when the address combination provided is invalid.

  • Name
    401
    Description

    Authentication failed. This occurs when the API key is missing, invalid, or expired.

  • Name
    402
    Description

    Payment required. This occurs when you've exceeded your plan's usage limits.

  • Name
    403
    Description

    Access forbidden. This occurs when your API key doesn't have permission to access this resource.

  • Name
    429
    Description

    Too many requests. You've exceeded the rate limit for API calls. Please retry after the cooldown period.

  • Name
    500
    Description

    Server encountered an unexpected error while processing the request. Please try again later.