Skip to content

Get details

Request

Get the full address details for a prediction.

Exchanges a prediction ID (where action was resolve) for a full, formatted address object that can be used to populate the address form fields.

This is the second step of the autocomplete flow — called after the user selects a final address prediction from the autocomplete results.

Security
BearerAuth
Path
idstringrequired

The opaque identifier from a prediction (where action was resolve).

Query
siteIdstring, non-empty(Address.SiteId)required

Site identifier, referring to which site the address is resolved for.

curl -i -X GET \
  'https://docs.ingrid.com/_mock/developer-resources/ingrid-api/openapi/v1/address/details/{id}?siteId=00000000-0000-0000-0000-000000000000' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The request has succeeded.

Bodyapplication/json
addressobject(Address.Address)required

The full address resolved from the prediction.

Response

Returns the full address for a resolved French prediction ID

{
  "address": {
    "countryCode": "FR",
    "postalCode": "75001",
    "addressLines": [ … ],
    "locality": "Paris"
  }
}