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
  • Fields
  • Requirement Item
  1. API Reference
  2. Data Dictionary
  3. Objects

Requirement

The Requirements object represents personal details requested by the initiator during an activity. The recipient (receptor) determines which details to share to complete the activity.

Fields

Field
Type
Description

code

string

Unique identifier for this requirement.

type

string

Specifies the type of requirement.

category

string

Category of the requirement.

data

object

Contains personal details for requirements involving data sharing. Note: This field appears only in the accepted_requirements array within the Activity object.

items

array

Contains a detailed list of personal details involving grouped requirements. Examples include:

  • IDENTITY TRUST = "RQ_002"

  • PERSONAL INFO = "RQ_004"

  • IDENTITY DOCUMENT = "RQ_006"

Note: Refer to the Requirement Item table for structure details.

Requirement Item

The Requirement Item object represents detailed sub-requirements within a larger group of personal details requested during an activity.

Field
Type
Description

code

string

Unique code identifying this specific inner requirement

type

string

Specifies the type of sub-requirement.

data

object

Contains a detailed list of personal details associated with grouped requirements. Examples include:

  • IDENTITY TRUST = "RQ_002"

  • PERSONAL INFO = "RQ_004"

  • IDENTITY DOCUMENT = "RQ_006"

Note: This field appears only in the accepted_requirements array within the Activity object.

This structure allows for a more granular breakdown of individual requirements, ensuring clarity and flexibility during implementation.

PreviousActivityNextWebhook

Last updated 5 months ago