Community

The Community endpoint provides access to all registered users on the mio.ID platform, including individuals and businesses. This allows your application to interact with users by sending or receiving activities such as identity verification requests, compliance checks, or other transactions.

GET List All Members Retrieves a comprehensive list of registered users.

GET Search Member by Phone number Locates a specific individual or business by their associated phone number.

List of registered people/businesses in our platform

get

List of registered people/businesses in our platform, for you to sent/receive an activity

Authorizations

AuthorizationstringRequired

Enter JWT token

Query parameters

namestringOptional

Name to search for

Example: John Doe

limitnumberOptionalDefault: 20Example: 10

pagenumberOptionalDefault: 1Example: 5

Header parameters

x-api-keystringRequired

Your credential's unique identifier key

x-pvt-timezonestringOptional

Your timezone

Responses

200

Returns list of registered people/businesses

application/json

idstringRequired

Member ID

Example: 4e23c659-306a-46fc-8333-7699b9943475

namestringRequired

Member's name

Example: John Doe

cifcodestringRequired

Member's secondary identifier

Example: 0b812663-e6b2-421a-9a59-0f9579378221

typestring · enumRequired

Member type

Example: INDIVIDUALPossible values:

avatarstringRequired

Member's avatar's URL

Example: https://cdn.mio.id/my-avatar

scorenumberRequired

Member's scoring

Example: 650

scoring_levelstringRequired

Member's scoring level

Example: GOOD

created_atnumberRequired

unregisteredbooleanOptional

This property is present only when a member has deleted its account

get/business/v1/community

GET /business/v1/community HTTP/1.1
Host: api.mio.id
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
Accept: */*

200

Returns list of registered people/businesses

[
  {
    "id": "4e23c659-306a-46fc-8333-7699b9943475",
    "name": "John Doe",
    "cifcode": "0b812663-e6b2-421a-9a59-0f9579378221",
    "type": "INDIVIDUAL",
    "avatar": "https://cdn.mio.id/my-avatar",
    "score": 650,
    "scoring_level": "GOOD",
    "social_media": [
      {
        "media": "X",
        "url": "https://x.com/mioid"
      }
    ],
    "created_at": 1,
    "unregistered": true
  }
]

Returns member found with phone

get

Returns member found with phone

Authorizations

AuthorizationstringRequired

Enter JWT token

Path parameters

phonestringRequired

Individual's phone number to validate its existence

Example: US_9876543210

Header parameters

x-api-keystringRequired

Your credential's unique identifier key

x-pvt-timezonestringOptional

Your timezone

Responses

200

Returns member found with phone

application/json

idstringRequired

Member ID

Example: 4e23c659-306a-46fc-8333-7699b9943475

namestringRequired

Member's name

Example: John Doe

cifcodestringRequired

Member's secondary identifier

Example: 0b812663-e6b2-421a-9a59-0f9579378221

typestring · enumRequired

Member type

Example: INDIVIDUALPossible values:

scorenumberRequired

Member's scoring

Example: 650

scoring_levelstringRequired

Member's scoring level

Example: GOOD

created_atnumberRequired

get/business/v1/community/phone/{phone}

GET /business/v1/community/phone/{phone} HTTP/1.1
Host: api.mio.id
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
Accept: */*

200

Returns member found with phone

{
  "id": "4e23c659-306a-46fc-8333-7699b9943475",
  "name": "John Doe",
  "cifcode": "0b812663-e6b2-421a-9a59-0f9579378221",
  "type": "INDIVIDUAL",
  "score": 650,
  "scoring_level": "GOOD",
  "social_media": [
    {
      "media": "X",
      "url": "https://x.com/mioid"
    }
  ],
  "created_at": 1
}