Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note

The API is case sensitive, for example if country (“US”) isn't capitalized or language (“en”) doesn’t match these cases, the request will return an error.

Zipcode/Postcode Format

Info

To ensure zipcodes/postcodes are formatted appropriately in each market, please download and review the country & regex file below

View file
namecountry & regex

...

Sample Response

Code Block
Success:
 {
     "zipcode": "29692",
     "qualifications": [
         {
             "question_id": 223,
             "question_name": "Region",
             "answer_id": "3",
             "answer_name": "South"
         },
         {
             "question_id": 224,
             "question_name": "Division",
             "answer_id": "5",
             "answer_name": "South Atlantic"
         },
         {
             "question_id": 225,
             "question_name": "State",
             "answer_id": "45",
             "answer_name": "South Carolina"
         },
         {
             "question_id": 231,
             "question_name": "Dma",
             "answer_id": "567",
             "answer_name": "GREENVLL-SPART-ASHEVLL-AND"
         },
         {
             "question_id": 227,
             "question_name": "Csa",
             "answer_id": "24940",
             "answer_name": "Greenwood, SC"
         },
         {
             "question_id": 228,
             "question_name": "County",
             "answer_id": "45047",
             "answer_name": "Greenwood"
         }
     ]
 }

...

Warning

{

    "statusCode": 400,

    "msg": "Country/Language combination is not supported"

}

{

    "statusCode": 400,

    "msg": "Zipcode is not supported"

}

{
"statusCode": 400,
"msg": "Zipcode formatting is incorrect, please refer to our validation rules- /^([0-9]{3,5})$/i"
}

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#FFFFFF

These will be adjusted with an additional release going to production 6/4