Skip to content
BuildBase
HTTP API menu

Look up the code a device shows and start a sign-in for it

No router-level gate: the org comes in the body.

POST/api/v1/auth/device/lookup

Sign-in
None at the router: the operation is public, or checks its own proof (a signature, a token in the body, a signed link).
Rate limit
Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted); up to 30 requests a minute per IP address.

No router-level gate: the org comes in the body. Returns a new auth state for the device sign-in with the client's name and requested scopes; answers 400 invalid_code for an unknown code or a client without the device grant, and 429 after too many wrong codes from one network.

Request

Send the body as application/json.

Body

FieldTypeRequiredConstraintsDescription
orgIdstringYes24 to 33 characters-
userCodestringYes1 to 32 characters-

Example request

Replace each YOUR_... value with your own.

curl -X POST "https://api.console.buildbase.app/api/v1/auth/device/lookup" \
  -H "Content-Type: application/json" \
  -d '{
  "orgId": "YOUR_ORG_ID",
  "userCode": "string"
}'
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/auth/device/lookup',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      orgId: 'YOUR_ORG_ID',
      userCode: 'string',
    }),
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.json();
import requests

response = requests.post(
    "https://api.console.buildbase.app/api/v1/auth/device/lookup",
    json={
        "orgId": "YOUR_ORG_ID",
        "userCode": "string",
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()

Responses

200 OK

OK

Example
{
  "client": {
    "title": "E2E TV App",
    "unverified": false
  },
  "requestedFrom": {
    "ip": "127.0.0.1",
    "userAgent": "undefined"
  },
  "scope": ["read", "write"],
  "state": "BKjSb6vgXlaQ8MZtdMdrzB9D0yNmG4",
  "success": true
}

Any other status

Any other answer the handler sends itself (its own refusals). Not described yet.

Errors

Each refusal, what it means, and what to do. The request changed nothing.

400 Bad Request

What it means: The request failed a validate() schema, or an id in the path is not a valid id. path names the field.

What to do: Fix the field the body names in path (or read message) and send the request again. Nothing was changed.

Example
{
  "error": true,
  "success": false,
  "path": "string",
  "message": "string"
}

429 Too Many Requests

What it means: A rate limit in x-rateLimit was reached. retryAfter and the Retry-After header say how many seconds until the window resets.

What to do: Wait the number of seconds in the Retry-After header (also retryAfter in the body), then retry. Slow down repeated calls.

Example
{
  "success": false,
  "message": "string",
  "reason": "rate_limited",
  "retryAfter": 1
}