> For the complete documentation index, see [llms.txt](https://docs.payengine.co/payengine-api-v2.5/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.payengine.co/payengine-api-v2.5/onboarding/get-address-auto-fill.md).

# Get address auto fill

## Get address auto fill

<mark style="color:green;">`POST`</mark> `https://<Platform-host>/common/address-auto-fill`

This endpoint allows you to get address information for helping pre-fill user input fields.

#### Request Body

| Name    | Type   | Description                                      |
| ------- | ------ | ------------------------------------------------ |
| address | string | Pre-fill address, minimum length of 3 characters |

{% tabs %}
{% tab title="200 Returns a suggested address" %}

```
{
    "data": [
        {
            "street_number": "11",
            "street_name": "Jungle Rd",
            "city": "Leominster",
            "county": "Worcester County",
            "state": "Massachusetts",
            "state_code": "MA",
            "country": "United States",
            "country_code": "US",
            "zip": "01453",
            "formatted_address": "11 Jungle Rd, Leominster, MA 01453, USA",
            "location": {
                "lat": 42.4920805,
                "lng": -71.7297272
            }
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Raw body" %}

```javascript
{
    "address": "11 Jungle Road"
}
```

{% endtab %}
{% endtabs %}