Skip to content
clearance.rest

Create a QR token to connect a device number

POST
/numbers/device/claim/rest
curl --request POST \
  --url https://api.clearance.rest/numbers/device/claim/rest \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "label": "example", "preview": "0" }'

The token is single-use and valid for 30 seconds; use the claim socket for a QR that refreshes itself. preview=true returns the QR as an SVG image.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
label
string
<= 255 characters
preview
Any of:
boolean

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
Any of:
object
success
required
boolean
token
required
string
expires_at
required
number
qr_payload
required
string
apk_url
required
string
Example
{
  "success": true
}

401

Section titled “401”

Default Response

Media typeapplication/json

Error envelope returned by every JSON endpoint.

object
success
required
boolean
error
required
object
code
required

Machine-readable error code (snake_case).

string
message
required

Human-readable message.

string
details

Extra context for the error.

object
key
additional properties
Example
{
  "success": false
}

403

Section titled “403”

Default Response

Media typeapplication/json

Error envelope returned by every JSON endpoint.

object
success
required
boolean
error
required
object
code
required

Machine-readable error code (snake_case).

string
message
required

Human-readable message.

string
details

Extra context for the error.

object
key
additional properties
Example
{
  "success": false
}