Entity Management

The Entity Management API provides a single interface to create and maintain every business object that drives payments in Bead.

Partner → Merchant → Location → Terminal → Payment

It covers the full life-cycle, from initial KYB onboarding through routine updates, so you can automate provisioning flows and build self-service dashboards.

Why use Entity Management

Need	How the API helps
Onboard a new merchant	Submit KYB details and generate a hosted onboarding link.
Track onboarding progress	Query status to see missing or invalid fields.
Manage locations	Add, rename, or deactivate merchant locations.
Manage terminals	Create, list, update, disable, or delete devices; set device-level webhooks.

Available sections

Section	Description
Onboarding	KYB submission and hosted onboarding links for merchants and partners.
Merchant Management	CRUD operations and status checks for merchants.
Location Management	Create and maintain merchant locations.
Terminal Management	Full device life-cycle, including webhooks.

Navigation

• Onboarding

• Merchant Management

• Location Management

• Terminal Management

• Change Log

Getting started

1. Obtain an access token (see the Authentication page).

2. Create or retrieve the parent objects in order (partner → merchant → location).

3. Provision terminals under the correct location.

4. Use the terminalId when creating payments.

Need help

Email [e-mail] and the Bead integration team will respond.