POST
Request a POS registration
No sign-in needed For: Integrator Conditions
  • The registration_key must be the organization’s POS registration key (26-character ULID); an unknown key is refused.
  • organization_id and company_id are prohibited; the organization comes from the key.
  • A computer that already has an active sync device in the organization, or an open request, is refused; the same applies to a host fingerprint.
  • The route is limited to 5 calls per minute.
  • A concurrent duplicate of an open request is refused with 409.
What else happens
  • Creates a pending registration request and returns a one-time request token to the device. The token is stored only as a hash.
Part of Connect offline POS devices.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
registration_key
enum<string>
required

The organization's POS registration key (26-character ULID). Required; it identifies the organization and must exist.

Available options:
Required string length: 26
name
string
required

Display name of the computer, up to 120 characters. Required.

Maximum string length: 120
computer_id
string
required

Stable identifier of the computer, up to 255 characters. Required; refused if the organization already has an active device or an open request for it.

Maximum string length: 255
host_fingerprint
string
required

Fingerprint of the host, up to 255 characters. Required; stored only as a hash; refused if already used by an active device or open request.

Maximum string length: 255
organization_id
string

Identifier of the organization the record belongs to.

company_id
string

Identifier of the company the record belongs to.

platform
enum<string> | null

Operating system: darwin, win32 or linux. Optional.

Available options:
darwin,
win32,
linux

Response

PosSyncInstanceRegistrationSubmissionResource

data
PosSyncInstanceRegistrationSubmissionResource · object
required

Items of this page.