---
title: "POST /v1/partners/{partnersId}/devices:claim"
method: POST
path: "/v1/partners/{partnersId}/devices:claim"
tags: ["partners"]
---

# POST /v1/partners/{partnersId}/devices:claim

`POST /v1/partners/{partnersId}/devices:claim`

## Request

- Base URL: `https://androiddeviceprovisioning.googleapis.com`
- URL: `https://androiddeviceprovisioning.googleapis.com/v1/partners/{partnersId}/devices:claim`
- Auth: none declared

Claims a device for a customer and adds it to zero-touch enrollment. If the device is already claimed by another customer, the call returns an error.

## Path parameters

- `partnersId` string, required

## Request body

- ClaimDeviceRequest: Request message to claim a device on behalf of a customer.
  - `configurationId` string, int64: Optional. The ID of the configuration applied to the device section.
  - `customerId` string, int64: The ID of the customer for whom the device is being claimed.
  - `deviceIdentifier` DeviceIdentifier: Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
    - `chromeOsAttestedDeviceId` string: An identifier provided by OEMs, carried through the production and sales process. Only applicable to Chrome OS devices.
    - `deviceType` 'DEVICE_TYPE_UNSPECIFIED' | 'DEVICE_TYPE_ANDROID' | 'DEVICE_TYPE_CHROME_OS': The type of the device
    - `imei` string: The device’s IMEI number. Validated on input.
    - `imei2` string: The device’s second IMEI number.
    - `manufacturer` string: The device manufacturer’s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [Android manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
    - `meid` string: The device’s MEID number.
    - `meid2` string: The device’s second MEID number.
    - `model` string: The device model's name. Allowed values are listed in [Android models](/zero-touch/resources/manufacturer-names#model-names) and [Chrome OS models](https://support.google.com/chrome/a/answer/10130175#identify_compatible).
    - `serialNumber` string: The manufacturer's serial number for the device. This value might not be unique across different device models.
  - `deviceMetadata` DeviceMetadata: Metadata entries that can be attached to a `Device`. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
    - `entries` object: Metadata entries recorded as key-value pairs.
  - `googleWorkspaceCustomerId` string: The Google Workspace customer ID.
  - `preProvisioningToken` string: Optional. Must and can only be set for Chrome OS devices.
  - `sectionType` 'SECTION_TYPE_UNSPECIFIED' | 'SECTION_TYPE_SIM_LOCK' | 'SECTION_TYPE_ZERO_TOUCH': Required. The section type of the device's provisioning record.
  - `simlockProfileId` string, int64: Optional. Must and can only be set when DeviceProvisioningSectionType is SECTION_TYPE_SIM_LOCK. The unique identifier of the SimLock profile.

## Response `200`

Successful response

- ClaimDeviceResponse: Response message containing device id of the claim.
  - `deviceId` string, int64: The device ID of the claimed device.
  - `deviceName` string: The resource name of the device in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.

---

[API](https://skmtc.dev/google/apis/androiddeviceprovisioning.md) - [All operations](https://skmtc.dev/google/apis/androiddeviceprovisioning/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/androiddeviceprovisioning/revisions/87b1e2664607?raw)