mio.ID Business
  • Getting started
    • Overview
  • API Reference
    • Data Dictionary
      • Glossary
        • Entity or Member
        • Activity
        • Requirement
      • Objects
        • Entity or Member
        • Activity
        • Requirement
        • Webhook
    • API endpoints
  • webhooks
    • Registration
    • Security
Powered by GitBook
On this page
  1. API Reference
  2. Data Dictionary
  3. Objects

Activity

The Activity object represents the various types of actions and events within the mio.ID platform, initiated by or involving both individual and business entities. It is a key component for tracking, analyzing, and reporting interactions, providing detailed metadata about each activity's lifecycle and status.

Fields

Field
Type
Description

id

string

Unique identifier for this activity

entity

object

type

string

Specifies the type of activity. Its values can be:

  • AT_001

  • AT_002

  • AT_003

  • AT_004

type_name

string

Human-readable description of the activity type.

in_out_bound

string

Indicates the direction of the activity. Its value can be:

  • IN (Inbound)

  • OUT (Outbound)

requirements

array

accepted_requirements

array

declined_requirements

array

description

string

A message from the initiator sent as part of the activity.

status

string

notification_message

string

A completion message sent by the recipient to the initiator when the activity is completed.

timeline

array

A log of activity statuses and their timestamps.

time_zone

string

The timezone in which the activity occurred.

expires_in

object

Period for which the activity is valid, set by the recipient. Once expired, the initiator loses access to the recipient's shared details.

expires_at

number

Timestamp indicating when the personal details are no longer available to the initiator due to expiration.

attended_at

number

Timestamp when the recipient made a decision (accepted or declined).

completed_at

number

Timestamp when the activity was marked as COMPLETED.

valid_until

number

Time limit for the recipient to decide on the activity. Once expired, the activity becomes inactive.

created_at

object

Datetime when Activity has been created.

updated_at

object

Datetime when Activity has been updated.

PreviousEntity or MemberNextRequirement

Last updated 5 months ago

The participant involved in the activity, either sending or receiving it. Refer to for more information.

Refer to for more information.

List of requested or shared during the activity.

List of that the recipient accepted to share with the initiator.

List of that the recipient declined to share.

Current status of the activity. Refer to for more information.

Member
Requirements
Requirements
Requirements
Activity Type
Activity Status