Address API - Errors

This page describes the errors you might encounter when using the Address API.

General

General information about the API can be found in the Address API - Backend Integration Guide.

Observability

All Ingrid responses will containt a x-trace-id header. In case of any problems or question, providing this value to us will allow us to go back to you with more accurate feedback.

< HTTP/2 200
< content-type: application/json
< x-trace-id: D20260128100011E5E41HYJJSPATG00
<
{...}

Errors

In case of any errors, Ingrid will return a 4xx or 5xx HTTP status code. The response body will contain a JSON object with the following structure:

{
  "error": "unauthenticated: rpc error: code = InvalidArgument desc = malformed authorization token",
  "trace_id": "D20260128095524VXP825X5YX020BMP"
}

Timeout

We recommend setting the timeout to 3 seconds for the Address API endpoints.

Errors

This section describes in detail the errors you might encounter when using the Address API.

Unauthenticated

The request is unauthenticated. This means that the API token is missing or invalid.

{
  "error": "unauthenticated: rpc error: code = InvalidArgument desc = malformed authorization token",
  "trace_id": "D20260128095524VXP825X5YX020BMP"
}

Validation

The request is invalid. This means that the request body is missing a field or the value is invalid. Check the request body and the error message for more details.

{
  "error": "validation errors:\n - contact.address.country_code: value does not match regex pattern `^[A-Z]{2}$`\n - contact.address.coordinates.lat: value is required\n - contact.address.coordinates.lng: value is required\n - contact.email: value must be a valid email address\n - contact.phone_number.country_code: value does not match regex pattern `^[A-Z]{2}$`",
  "trace_id": "D202601290951342C4J17SMTSRC0X97"
}