Add Role to Token Registry

Assign an organization-level access role to an address for a specific Token Registry. These roles control who within the End User organisation can perform actions such as issuing, accepting, or restoring electronic trade documents (eBL / ETRs).

What these roles are (important)

The following roles are access control roles, not document lifecycle roles:

RolePurpose
AdminManages registry configuration and roles
MinterAllowed to issue (mint) new ETRs (eBL / ePN)
AccepterAllowed to accept incoming ETR transfers
RestorerAllowed to restore or return ETRs to issuer

These roles define who is authorized to perform actions within the End User organisation.

How this fits in the Trade flow

  • Called by the Integrating System
  • Used after Token Registry deployment and DNS validation
  • Grants organisational permissions to specific addresses
  • Requires explicit End User approval
  • Approval happens only via redirect URL and End User passkeys

Role changes affect organizational control and therefore require End User approval.

What happens next

  1. The Integrating System redirects the End User to redirectUrl
  2. The End User reviews the role assignment
  3. The End User approves the action using passkeys
  4. The role is assigned to the specified address
  5. The Integrating System stores the updated role configuration

Without End User approval, the role is not assigned.


📌 Responsibility clarification

  • Roles belong to the End User organization
  • BlockPeer does not store organizational role mappings
  • The Integrating System must store:
    • Registry address
    • Addresses assigned to each role
    • Role configuration per organization

BlockPeer acts only as TradeTrust infrastructure.


Important notes

  • Each role assignment is a separate approved action
  • Network transaction fees apply (paid by the End User-controlled account)
  • Role changes affect who can issue or manage ETRs

Common use cases

  • Assign Admin role to a compliance or ops lead
  • Assign Minter role to a shipping or trade operations team
  • Assign Accepter role to a receiving or finance team
  • Assign Restorer role for exception handling and returns
Body Params

Role assignment request details

string
required
string
required
string
required
string
enum
required
Defaults to ADMIN

Select the role

Allowed:
string
enum
required
Defaults to STABILITY

Select the blockchain network

Headers
string

Unique key to ensure idempotency for API requests.

string

Unique external ID for tracking purposes, can be used for debugging and analytics.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json