Address Analyzer

Response structure

The response contains the following fields:

  • label – Text with the full address in the format road, number, district, zipcode, city, state, with the correction suggestion applied to the fields;
  • road – Text with the street name. When the status is CORRECTED, it is the suggested official street name; otherwise, the street sent, already standardized;
  • number – Text with the building number;
  • complement – Text with the complement identified in the address sent;
  • district – Text with the district. When the status is CORRECTED, it is the suggested official district name; otherwise, the value sent;
  • zipcode – Text with the ZIP code, with 8 digits and numbers only;
  • city – Text with the city. When the status is CORRECTED, it is the suggested official city name; otherwise, the value sent;
  • state – Text with the state abbreviation (UF), with 2 letters;
  • matchScore – Number (double) from 0 to 100 indicating the degree of match between the street sent and the official street for the ZIP code provided. Returned for every status;
  • status – Text indicating the analysis result. Possible values are:
    • CORRECTED – A correction suggestion was found. The road, district, city and state fields contain the suggested official names;
    • NORMALIZED – The address was only standardized, with no correction suggestion, because the match with the official address for the ZIP code provided could not be confirmed.

Note: when the status is CORRECTED, the district and state fields are filled even if they were not sent. When the status is NORMALIZED, the fields are returned with the values sent in the request.

Full request and response examples can be found at the following link: Examples.