Skip to main content
POST
cURL

Body

application/json

A new shared device or kiosk enrolling with the code of a QR, with a DPoP proof in the DPoP header signed by its new key.

code
string
required

The 32 character code of the QR, or typed in.

Required string length: 32
Example:

"MFRGGZDFMZTWQ2LKNNWG23TPOBYXE43U"

platform
enum<string>
required

ios, ipados, android, macos, windows or linux.

Available options:
ios,
ipados,
android,
macos,
windows,
linux
Example:

"android"

model
string
required

The hardware model.

Maximum string length: 80
Example:

"Farset F35S"

os_version
string
required

The operating system version.

Maximum string length: 40
Example:

"16"

app_version
string
required

The app version.

Maximum string length: 20
Example:

"1.4.2"

app_build
integer
required

The app's build number.

Required range: 0 <= x <= 2147483647
Example:

311

name
string | null

A name for the device; the enrollment's name prefix comes first. Do not name a person in it.

Maximum string length: 30
Example:

"2"

attestation
object | null

What App Attest or Play Integrity said about this install. Recorded as a signal and never enforced.

Response

DeviceCredentialResource

data
DeviceCredentialResource · object
required