Skip to main content
POST
/
v1
/
onboarding
/
eligibility
/
check
check eligibility for zipcode
curl --request POST \
  --url https://api.example.com/v1/onboarding/eligibility/check \
  --header 'Content-Type: application/json' \
  --header 'x-ws-api-key: <api-key>' \
  --data '
{
  "zipcode": "94107"
}
'
{
  "supported": true,
  "wholesaleMarket": true,
  "tariffData": true,
  "demandResponsePrograms": [
    "CAISO"
  ],
  "reason": "Zipcode is supported for onboarding."
}

Authorizations

x-ws-api-key
string
header
required

Headers

x-ws-api-key
string

WattShift API Key

Body

application/json
zipcode
string
required

Response

200 - application/json
supported
boolean
required
wholesaleMarket
boolean
required
tariffData
boolean
required
demandResponsePrograms
string[]
required
reason
string