Create enrollment

https://api.kustom.co/ipp/v1/enrollments

Creates a new enrollment code that a device can use to register.

Request body

201

400

401

Example

Request body4 fields

• metadataobjectoptional

  Custom metadata key-value pairs for the enrollment.

  1 field in metadata

  • keystringoptional

    Any additional property. The key is free-form; the value has this shape.

• ttlstringrequired

  Duration the enrollment code is valid for. TWO_HOURS produces a short 8-character code; longer durations produce a UUID-format code.

  • TWO_HOURS
  • TWENTY_FOUR_HOURS
  • FORTY_EIGHT_HOURS
  • SEVENTY_TWO_HOURS
  • THIRTY_DAYS
• location_idstring · uuidoptional

  Location ID to associate the enrolled device with.

201

Response6 fields

Enrollment created.

• enrollment_idstring · uuidoptional

  Unique enrollment identifier.

• enrollment_codestringoptional

  The enrollment code to enter on the device.

• expires_atstring · date-timeoptional

  Timestamp when the enrollment code expires.

• statusstringoptional

  Current status of the enrollment.

  • PENDING
  • CONSUMED
  • EXPIRED
  • CANCELLED
• metadataobjectoptional

  Custom metadata key-value pairs for the enrollment.

  1 field in metadata

  • keystringoptional

    Any additional property. The key is free-form; the value has this shape.

400

Response0 fields

Invalid request body.

No response body — this status returns headers only.

401

Response0 fields

Missing or invalid credentials.

No response body — this status returns headers only.

POST https://api.kustom.co/ipp/v1/enrollments

RequestBodyResponse201400401

Request body· application/json

{
  "metadata": {
    "store_id": "123",
    "terminal_type": "checkout"
  },
  "ttl": "TWO_HOURS",
  "location_id": "550e8400-e29b-41d4-a716-446655440000"
}

8 linesCopy

Response 201· Enrollment created.

{
  "enrollment_id": "550e8400-e29b-41d4-a716-446655440000",
  "enrollment_code": "ABC123XYZ",
  "expires_at": "2024-01-15T11:30:00Z",
  "status": "PENDING",
  "metadata": {
    "store_id": "123",
    "terminal_type": "checkout"
  }
}

10 linesCopy

Response 400· Invalid request body.

No response body.

This status returns headers only — there is nothing to parse.

—

Response 401· Missing or invalid credentials.

No response body.

This status returns headers only — there is nothing to parse.

—