Skip to main content

​
Overview

BuildPass operates separate tenant environments in Australia and the United States. Each of your client’s BuildPass accounts is hosted in one of these regions. Use the appropriate region identifier to connect to each client’s tenant.

​
Available regions

RegionRegion CodeLocation
Australia (Default)au1 or omittedSydney, Australia
United Statesus1Ohio, United States

​
Usage

​
Setting the region

To route your requests to a specific client’s region, include the X-BuildPass-Region-Id header in your API requests: 
curl -X GET "https://api.buildpass.global/builders" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-BuildPass-Api-Version: v1" \
  -H "X-BuildPass-Region-Id: us1"

​
Default behavior

If the X-BuildPass-Region-Id header is:
  • Not provided: Defaults to Australia (au1)
  • Unrecognized value: Defaults to Australia (au1)
This ensures backward compatibility with existing integrations.

​
How it works

Simply include the X-BuildPass-Region-Id header in your API requests to connect to your client’s tenant. Each client’s BuildPass account is hosted in either Australia or the United States—use the corresponding region code to access their data.

​
Examples

​
OAuth token request (US region)

curl -X POST "https://api.buildpass.global/oauth/token" \
  -H "Content-Type: application/json" \
  -H "X-BuildPass-Api-Version: v1" \
  -H "X-BuildPass-Region-Id: us1" \
  -d '{
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET",
    "grant_type": "client_credentials",
    "scope": "read:builders",
    "audience": "https://api.buildpass.global"
  }'

​
Australia region (default)

If you don’t specify a region, requests automatically use the Australia data centre: 
curl -X GET "https://api.buildpass.global/builders" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-BuildPass-Api-Version: v1"

​
United States region

To use the US data centre, add the region header: 
curl -X GET "https://api.buildpass.global/builders" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-BuildPass-Api-Version: v1" \
  -H "X-BuildPass-Region-Id: us1"

​
Need help?

If you’re unsure which region a client’s account is hosted in or have questions about implementing multi-region support in your integration, please contact your BuildPass account manager or reach out to our support team at support@buildpass.com.au.