# ai.newnal.illi.device.requestOnboardingCode

> Published by [illi-service.newnal.id](https://lexicon.garden/identity/did:plc:uztm7bi2ce42dez3uu3qafro)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:uztm7bi2ce42dez3uu3qafro/ai.newnal.illi.device.requestOnboardingCode)
- [Documentation](https://lexicon.garden/lexicon/did:plc:uztm7bi2ce42dez3uu3qafro/ai.newnal.illi.device.requestOnboardingCode/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:uztm7bi2ce42dez3uu3qafro/ai.newnal.illi.device.requestOnboardingCode/examples)

## Definitions

### `ai.newnal.illi.device.requestOnboardingCode`

**Type**: `procedure`

Register the device (device id, model) under parent 1's device-app session and issue a one-time onboarding code shown on the device.

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `attestation` | `string` | No |  |
| `deviceId` | `string` | Yes |  |
| `firmwareVersion` | `string` | No |  |
| `model` | `string` | Yes |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `code` | `string` | Yes |  |
| `deviceId` | `string` | Yes |  |
| `expiresAt` | `string` (datetime) | Yes |  |

#### Errors

- **DeviceAlreadyLinked**
- **InvalidAttestation**
- **DeviceRevoked**
- **RateLimitExceeded**

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Register the device (device id, model) under parent 1's device-app session and issue a one-time onboarding code shown on the device.",
      "errors": [
        {
          "name": "DeviceAlreadyLinked"
        },
        {
          "name": "InvalidAttestation"
        },
        {
          "name": "DeviceRevoked"
        },
        {
          "name": "RateLimitExceeded"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "attestation": {
              "type": "string"
            },
            "deviceId": {
              "maxLength": 64,
              "type": "string"
            },
            "firmwareVersion": {
              "maxLength": 32,
              "type": "string"
            },
            "model": {
              "maxLength": 64,
              "type": "string"
            }
          },
          "required": [
            "deviceId",
            "model"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "code": {
              "type": "string"
            },
            "deviceId": {
              "type": "string"
            },
            "expiresAt": {
              "format": "datetime",
              "type": "string"
            }
          },
          "required": [
            "deviceId",
            "code",
            "expiresAt"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "ai.newnal.illi.device.requestOnboardingCode",
  "lexicon": 1
}
```