post https://sandbox.link.kiban.cloud/api/v1/sepomex/search
Intro
This API is meant to validate a postal code into the SEPOMEX data base
Important points
Mandatory Field
codigoPostal field is required to validate the data.
Validations applied
The value for codigoPostal must only contain numbers and should have a length of 5 digits
Test cases
To recover a success response in sandbox environment is necessary to send a test case (see query parameter "testCase"). The posible values for the query param "testCase" are:
- complete it will return an example with dummy data provided for a Postal Code in SEPOMEX
- empty it will return an empty example, this case occurs if the postal code does not exist in SEPOMEX
Possible Errors
The next errors can be returned if there is a problem with the request body or the execution of this service:
"LENGTH_ERROR; should be = 5".
"FORMAT_ERROR; must only contain numbers".
Possible responses
If the postal code does not exist the service will return an empty response
If the postal code is valid it will return the next data:
- "Asentamiento"
- "Ciudad"
- "ClaveDeOficina"
- "CodigoPostal"
- "DelegacionMunicipio"
- "Estado"
- "TipoDeAsentamiento"