Skip to main content

🧡 Create and Send corporative event

Welcome to the complete guide for the "Create and Send corporative event" workflow for the Token City API.

This workflow enables you to create corporative event, send the corporative event to ERIR, and executes the corporative event if it's validated by ERIR.

🌟 Objective: Send a corporativee event to ERIR and executes if it's validated.


πŸ“š OpenAPI Documentation​


✨ Workflow Summary​

This workflow automates the process of send an corporative event to ERIR and get the resolution and executes if it's valid. Each type of corporative event has the same workflow, and shoud be validated by ERIR for the blockchain execution.

Previously requirments:

πŸ”Ή You already created an Issuer. πŸ”Ή You already created a project.


  1. πŸ”Ή Obtain events to know what corporate events can send.
  2. πŸ”Ή Send corporate event

🏷 Corporative event types​

You can find different corporative event types for each situtation. For inheritance, seizes, recovery funds of lost wallet, dividends payment... We offer different endpoints to achieve this condition in blockchain aspect.

  1. πŸ”Ή Forced Transfer from user A to user B.
  2. πŸ”Ή Burn Tokens
  3. πŸ”Ή Freeze / Unfreeze address
  4. πŸ”Ή Freeze / Unfreeze a token quantity for specific address
  5. πŸ”Ή Recovery address
  6. πŸ”Ή Dividend payment

πŸ“‹ Workflow Steps Table​

StepAPI OperationMethodParametersOutputsDescription
Get All EventsGET v2/proxy/erir/corporate-eventGETList of available events and required data for each one.Get all available events
Create a croporative eventPOST v2/proxy/erir/corporate-eventPOSTEIP712 type data declared on previous endpointsCorporate event data, eip712Object and required data and signaturesCreate a corporative event with its needed documents to be approved by ERIR
Execute a corporate eventPOST v2/proxy/erir/corporate-event/:id/executePOSTid-Executes the validated corporative event

🎨 Workflow Visualizations​

🌊 Mermaid Sequence Diagram​

sequenceDiagram
participant Client
participant GeneralAPI

Client->>GeneralAPI: GET v2/proxy/erir/corporate-event
GeneralAPI->>Client: CorporateEvent[]

Client->>GeneralAPI: POST v2/proxy/erir/corporate-event
GeneralAPI->>Client: CorporativeEvent ID

Client->>GeneralAPI: POST v2/proxy/erir/corporate-event/:id/execute
GeneralAPI->>Client: Event executed
GeneralAPI-->>Client: Webhook confirmation