Validate zipcode

GET /v1/client/zipcodes/{zipcode}/valid
Header api token & Header user Query api token & Query user

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
  • • 406 application/json

    VPN detected

    Hide response attributes Show response attributes object
GET /v1/client/zipcodes/{zipcode}/valid 
curl \
 -X GET https://api.bitlabs.ai/v1/client/zipcodes/{zipcode}/valid \
 -H "X-Api-Token: $API_KEY" \
 -H "X-User-Id: $API_KEY"
Response examples (200) 
{
  "data": {
    "valid": true
  }
}
Response examples (406) 
{
  "error": {
    "details": {
      "http": "406 Not Acceptable",
      "msg": "vpn detected"
    }
  }
}