Skip to main content
POST
Enroll a FinanceKit device publisher

Authorizations

X-Api-Key
string
header
required

API key for authentication. Generate one from your account settings.

Body

application/json
protocol_version
enum<integer>
required
Available options:
2
enrollment_id
string<uuid>
required
Pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$
replaces_connection_id
string<uuid>
Pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$

Response

Publisher enrolled pending account mapping

id
string<uuid>
required
Pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$
connection_id
string<uuid>
required
Pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$
publisher_id
string<uuid>
required
Pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$
status
enum<string>
required
Available options:
pending_mapping,
active,
repair_required,
revoked
generation
integer
required
Required range: x >= 1
next_sequence
integer
required
Required range: x >= 1
open_conflicts
integer
required
Required range: x >= 0
stream_id
string<uuid> | null
Pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$
repair_reason
string | null
last_device_contact_at
string<date-time> | null
last_accepted_at
string<date-time> | null
last_imported_at
string<date-time> | null
last_downstream_at
string<date-time> | null
last_captured_at
string<date-time> | null
accounts
object[]
pagination
object
purge_requested_at
string<date-time> | null
purge_completed_at
string<date-time> | null
disposition
enum<string>
Available options:
retain,
discard