Skip to main content
POST
Pair a chip

Authorizations

Authorization
string
header
required

Use Authorization: Bearer end_sk_* for partner API keys (e.g. end_sk_AbCd_example_api_key).

Body

application/json

Request to pair a chip to a unit. Pass is_test: true for a test chip, or chip_id + e (from the tap URL) for an encoded chip. Always requires unit_id.

unit_id
string<uuid>
required

Unit (resource) the chip is paired to.

Example:

"11111111-1111-1111-1111-111111111111"

is_test
enum<boolean>
required
Available options:
true

Response

201 - application/json

Created chip.

chip_id
string
required

Chip identifier from the tap URL.

Pattern: ^[0-9A-F]{10}$
Example:

"ABCDEF0123"

is_test
boolean
required
unit
object
required

Snapshot of the paired unit, including its collection and issuance status. Poll the unit (GET /v1/units/{unit_id}) until collection.token.status is active. Issuance has no failure status on this surface — if the unit stays pending well beyond a few minutes, stop polling and contact support.

scan_count
integer
required
Required range: x >= 0
created_at
string<date-time>
required