Validate each field of a Belgian address

Find out which field is wrong rather than only that the address is: every field comes back valid or not, with its official spelling.

Endpoint
POST https://addrly.be/api/v1/validate/components

Get a free API key Full reference and response fields

When to use it

A form that highlights the wrong field instead of rejecting the whole address.
A postcode and municipality pair that must match before the rest is typed.
Correcting one column of a file without touching the others.

Cost: 1 request per call
Authentication: X-API-Key header
Coverage: Every official address in Belgium

JSON body

Parameter	Type	Description
`street_fr` optional	`string`	The street name in French.
`street_nl` optional	`string`	The street name in Dutch. Send either language, or both.
`house_number` optional	`string`	The house number, with its suffix if any (12A, 12 bis).
`box_number` optional	`string`	The box number, without the bte or bus prefix.
`postcode` optional	`string`	The four-digit Belgian postcode.
`municipality_fr` optional	`string`	The municipality or postal locality in French.
`municipality_nl` optional	`string`	The municipality or postal locality in Dutch.

Request

curl -X POST "https://addrly.be/api/v1/validate/components" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"street_fr": "Rue de la Loi", "house_number": "16", "postcode": "1000"}'

Response

{
  "all_valid": true,
  "warnings":  [],
  "fields": {
    "postcode":     { "valid": true, "canonical": "1000" },
    "street_fr":    { "valid": true, "canonical": "Rue de la Loi" },
    "house_number": { "valid": true, "canonical": "16" },
    "box_number":   { "valid": null }
  }
}