Skip to main content
GET
/
datasources
/
mx
/
addresses
/
{postalCode}
Retrieve Mexico addresses by postal code
curl --request GET \
  --url https://api.syntage.com/datasources/mx/addresses/{postalCode} \
  --header 'X-API-Key: <api-key>'
{
  "@context": "/contexts/MxPostalCodeAddress",
  "@id": "/datasources/mx/addresses/11510",
  "@type": "hydra:Collection",
  "hydra:member": [
    {
      "@id": "/.well-known/genid/f2d82cee1ffcca39dbd2",
      "@type": "MxPostalCodeAddress",
      "postalCode": "11510",
      "neighborhood": "Los Morales",
      "neighborhoodType": "Colonia",
      "municipality": "Miguel Hidalgo",
      "state": "Ciudad de México",
      "stateCode": "CMX",
      "city": "Cd de Mexico",
      "officeKey": "01234"
    }
  ],
  "hydra:totalItems": 1,
  "hydra:view": {
    "@id": "<string>",
    "@type": "hydra:PartialCollectionView",
    "hydra:first": "<string>",
    "hydra:next": "<string>",
    "hydra:last": "<string>"
  },
  "hydra:search": {
    "@type": "<string>",
    "hydra:template": "<string>",
    "hydra:variableRepresentation": "<string>",
    "hydra:mapping": [
      {
        "@type": "<string>",
        "variable": "<string>",
        "property": "<string>",
        "required": true
      }
    ]
  }
}
Use this endpoint to retrieve Mexico address options for a five-digit postal code. Buró de Crédito and Buró Empresas require submitted addresses to match the official postal-code address catalog, so use this endpoint when collecting or validating addresses for those workflows. The response can contain multiple neighborhoods for the same postal code. Each item includes the neighborhood, neighborhood type, municipality, state, state code, city, and postal office key.

Authorizations

​
X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Path Parameters

​
postalCode
string
required

Five-digit Mexico postal code

Required string length: 5
Pattern: ^[0-9]{5}$
Example:

"11510"

Response

Mexico address options for the postal code

​
@context
string
Example:

"/contexts/MxPostalCodeAddress"

​
@id
string
Example:

"/datasources/mx/addresses/11510"

​
@type
string
default:hydra:Collection
​
hydra:member
object[]
​
hydra:totalItems
integer

Total number of items found

Required range: x >= 0
Example:

1

​
hydra:view
object

Pagination information

​
hydra:search
object