Geographic
Get Zipcode Verified
This endpoint verifies the zipcode requested.
URL
PROD https://api.skypostal.com/
TEST https://api-test.skypostal.com/
Endpoint
POST /wcf-services/service-geographic.svc/geographic/get-zipcode-verified
Request Parameters
Parameters | |
|---|---|
| Object - Required User Info Definition. |
| Object - Required Zip Code Info Definition. |
User Info Definition
Parameters | |
|---|---|
| Integer - Required This is the user code provided by Skypostal. |
| String - Required This is the app key provided by Skypostal. |
| String - Required This is the app key provided by Skypostal. |
Zip Code Definition
Parameters | |
|---|---|
| String - Required - (Brazil Only) 2 characters iso code. (e.g. BR, MX, US, etc.) |
| String - Required Zipcode to be verified. 8 numbers maximum allowed. |
Remember
user_code and app_key are generic credentials, make sure to request your own for TEST and PROD environemnts.
Observation
This endpoint is currently available only for Brazil.
The command should be run as in the following example:
{
"user_info": {
"user_code": 999,
"user_key":"provided_by_skypostal",
"app_key":"provided_by_skypostal"
},
"zip_code_info": {
"country_iso_code": "BR",
"zip_code": "95708770"
}
}The command will return the following format:
{
"additional_info": {
"internal": [],
"server": {
"server_id": null,
"server_time": 0
}
},
"data": {
"verified": true,
"zip_code_info": {
"country_iso_code": "BR",
"zip_code": "95708770"
}
},
"error": {
"error_description": null,
"error_location": null,
"system_error": false
}
}