{"id":4371,"date":"2026-11-12T19:27:23","date_gmt":"2026-11-12T19:27:23","guid":{"rendered":"https:\/\/developers.maplink.global\/?p=4371"},"modified":"2026-11-12T19:57:43","modified_gmt":"2026-11-12T19:57:43","slug":"response-structure","status":"publish","type":"post","link":"https:\/\/developers.maplink.global\/en\/response-structure\/","title":{"rendered":"Response structure"},"content":{"rendered":"\n<p class=\"wp-block-paragraph\">The response contains the following fields:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><code>label<\/code> \u2013 Text with the full address in the format <code>road, number, district, zipcode, city, state<\/code>, with the correction suggestion applied to the fields;<\/li>\n\n\n\n<li><code>road<\/code> \u2013 Text with the street name. When the status is <code>CORRECTED<\/code>, it is the suggested official street name; otherwise, the street sent, already standardized;<\/li>\n\n\n\n<li><code>number<\/code> \u2013 Text with the building number;<\/li>\n\n\n\n<li><code>complement<\/code> \u2013 Text with the complement identified in the address sent;<\/li>\n\n\n\n<li><code>district<\/code> \u2013 Text with the district. When the status is <code>CORRECTED<\/code>, it is the suggested official district name; otherwise, the value sent;<\/li>\n\n\n\n<li><code>zipcode<\/code> \u2013 Text with the ZIP code, with 8 digits and numbers only;<\/li>\n\n\n\n<li><code>city<\/code> \u2013 Text with the city. When the status is <code>CORRECTED<\/code>, it is the suggested official city name; otherwise, the value sent;<\/li>\n\n\n\n<li><code>state<\/code> \u2013 Text with the state abbreviation (UF), with 2 letters;<\/li>\n\n\n\n<li><code>matchScore<\/code> \u2013 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;<\/li>\n\n\n\n<li><code>status<\/code> \u2013 Text indicating the analysis result. Possible values are:\n<ul class=\"wp-block-list\">\n<li><code>CORRECTED<\/code> \u2013 A correction suggestion was found. The <code>road<\/code>, <code>district<\/code>, <code>city<\/code> and <code>state<\/code> fields contain the suggested official names;<\/li>\n\n\n\n<li><code>NORMALIZED<\/code> \u2013 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.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\n\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\">\n<p class=\"wp-block-paragraph\"><strong>Note:<\/strong> when the status is <code>CORRECTED<\/code>, the <code>district<\/code> and <code>state<\/code> fields are filled even if they were not sent. When the status is <code>NORMALIZED<\/code>, the fields are returned with the values sent in the request.<\/p>\n<\/blockquote>\n\n\n\n<p class=\"wp-block-paragraph\">Full request and response examples can be found at the following link: <a href=\"https:\/\/developers.maplink.global\/en\/examples\/\" data-type=\"link\" data-id=\"https:\/\/developers.maplink.global\/en\/examples\/\">Examples.<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"<p>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, the fields are returned with the values sent in the request. Full request and response examples can be found at the following link: Examples.<\/p>\n","protected":false},"author":6,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"inline_featured_image":false,"footnotes":""},"categories":[175,33],"tags":[],"class_list":["post-4371","post","type-post","status-publish","format-standard","hentry","category-address-analyzer-en","category-uncategorized"],"acf":[],"_links":{"self":[{"href":"https:\/\/developers.maplink.global\/en\/wp-json\/wp\/v2\/posts\/4371","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developers.maplink.global\/en\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developers.maplink.global\/en\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developers.maplink.global\/en\/wp-json\/wp\/v2\/users\/6"}],"replies":[{"embeddable":true,"href":"https:\/\/developers.maplink.global\/en\/wp-json\/wp\/v2\/comments?post=4371"}],"version-history":[{"count":4,"href":"https:\/\/developers.maplink.global\/en\/wp-json\/wp\/v2\/posts\/4371\/revisions"}],"predecessor-version":[{"id":4437,"href":"https:\/\/developers.maplink.global\/en\/wp-json\/wp\/v2\/posts\/4371\/revisions\/4437"}],"wp:attachment":[{"href":"https:\/\/developers.maplink.global\/en\/wp-json\/wp\/v2\/media?parent=4371"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developers.maplink.global\/en\/wp-json\/wp\/v2\/categories?post=4371"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developers.maplink.global\/en\/wp-json\/wp\/v2\/tags?post=4371"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}