π§΅ 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.
- πΉ Obtain events to know what corporate events can send.
- πΉ 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.
- πΉ Forced Transfer from user A to user B.
- πΉ Burn Tokens
- πΉ Freeze / Unfreeze address
- πΉ Freeze / Unfreeze a token quantity for specific address
- πΉ Recovery address
- πΉ Dividend payment
π Workflow Steps Tableβ
Step | API Operation | Method | Parameters | Outputs | Description |
---|---|---|---|---|---|
Get All Events | GET v2/proxy/erir/corporate-event | GET | List of available events and required data for each one. | Get all available events | |
Create a croporative event | POST v2/proxy/erir/corporate-event | POST | EIP712 type data declared on previous endpoints | Corporate event data, eip712Object and required data and signatures | Create a corporative event with its needed documents to be approved by ERIR |
Execute a corporate event | POST v2/proxy/erir/corporate-event/:id/execute | POST | id | - | 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