Validate zipcode

GET /v1/client/zipcodes/{zipcode}/valid

Validates a zipcode against rules for the country the request is coming from.

Path parameters

  • zipcode string Required

    A path-encoded zipcode. We validate it against rules for the country the request is coming from.

Responses

  • 200 application/json

    OK

    Hide response attribute Show response attribute object
    • data object
      Hide data attribute Show data attribute object
  • 406 application/json

    VPN detected

    Hide response attribute Show response attribute object
GET /v1/client/zipcodes/{zipcode}/valid 
curl \
 --request GET 'https://api.bitlabs.ai/v1/client/zipcodes/{zipcode}/valid'
Response examples (200) 
{
  "data": {
    "valid": true
  }
}
Response examples (406) 
{
  "error": {
    "details": {
      "msg": "vpn detected",
      "http": "406 Not Acceptable"
    }
  }
}