Objects

Across our API endpoints, several key objects are available to interact with, each serving a specific function within the mio.ID ecosystem. Below is a summary of the core objects and links to their detailed descriptions, including fields and use cases:

• Member Represents a registered individual or business in the mio.ID platform. Use Case: Interact with individuals or businesses, verify identity, or initiate activities. Endpoints: Accessible through Community-related APIs.

• Activity Represents requests, sharings, or exchanges initiated by members or businesses. Use Case: Create, track, or respond to data-sharing requests between entities. Endpoints: Includes APIs to list activities, retrieve details, and create requests.

• Requirement Defines conditions or prerequisites associated with an activity. Use Case: Set or retrieve specific requirements necessary to complete an interaction. Endpoints: Useful for customizing workflows based on compliance or business logic.

• Webhook Represents a configured endpoint for receiving real-time event notifications.

  Use Case: Automate workflows by subscribing to events like activity updates or member changes. Endpoints: Manage webhooks to receive notifications for specified events.

For detailed field information, request structure, and usage examples, refer to the respective object documentation in the API Developer Guide.