Introduction
The Address Analyzer API is a RESTful API that analyzes Brazilian addresses and suggests corrections, returning the address split into fields and with the official spelling. With t [...]
Address Analyzer
Posts
Building requests for the Address Analyzer API
Before you start using the API, you will need to obtain the authentication token. The following headers are required, where the word token must be replaced with the token obtained [...]
Parameter list
Address input formats The address can be sent in two ways: Both formats can be sent in the same request. In that case, the structured parameters take precedence and the label is ig [...]
Response structure
The response contains the following fields: Note: when the status is CORRECTED, the district and state fields are filled even if they were not sent. When the status is NORMALIZED, [...]
Examples
Example 1 – Address with a correction suggestion In this example, the address is sent in the label format, with an abbreviated street type, the ZIP code with a hyphen and the city [...]
Status Codes
Below is the table with the status codes for each endpoint available in the Address Analyzer API: Code Method Endpoint Description 200 POST https://api.maplink.global/address/v1/an [...]
Error messages
The table below shows all error messages the API can return in the message field: Parameter Message Description zipcode / label The zipcode field must contain exactly 8 digits The [...]
