.uiid File Specification & Integration Guide

description

1. Protocol & Overview

The .uiid file format is a standardized, portable JSON-structured identity container. It allows users to store, backup, transfer, and present their decentralized identity credentials—including full Core Identities and granular Alias identities—across web platforms and third-party applications.

Core Identity File (.uiid)

Contains complete account backup parameters, primary DID anchors, profile metrics, global vault storage, and linked aliases. Granting full account access when authenticated.

Alias Identity File (.uiid)

An isolated, contextual identity payload exported for a single alias. When used for login or app authentication, access is strictly restricted to that specific alias scope.

security

2. Security Feature Tiers

Users manage .uiid file capabilities in /dashboard/security via four progressive feature tiers:

Tier 0

Disabled

Disables all .uiid file export, import, and authentication endpoints. Hides options from the user interface.

Tier 1

Data Backup Only

Permits pure export and import functionality via .uiid files inside the Data Migration Center.

Tier 2

Login Support

Allows users to log in directly on the main UIID login portal by uploading their .uiid file.

Tier 3

Application Authentication

Full authentication capability for 3rd-party applications via the REST API endpoint /api/v1/auth/uiid.

code

3. Developer Guide & API Integration

Third-party applications can authenticate users directly by accepting a .uiid file upload and submitting it to the UIID authentication endpoint.

# HTTP POST Request to UIID IDP

POST /api/v1/auth/uiid HTTP/1.1

Host: id.uiid.org

Content-Type: multipart/form-data; boundary=----WebKitFormBoundary

Content-Disposition: form-data; name="uiid_file"; filename="my_identity.uiid"

# Successful Response Payload (JSON)

{
  "status": "success",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "user_id": 1042,
  "uiid_core_id": "did:uiid:8a92f1b4",
  "email": "[email protected]",
  "scope": "alias_scoped",
  "alias_id": "alias_82a17f",
  "alias_name": "Developer Persona"
}

schema

4. Data Specifications & Schemas

A. Core Credential Schema (uiid_core_credential)

{
  "file_type": "uiid_core_credential",
  "version": "2.0",
  "uiid_core_id": "did:uiid:xxxx-xxxx",
  "user_id": 1042,
  "export_metadata": {
    "exported_at": "2026-08-16T12:00:00Z",
    "source": "Linkspreed UIID-IDP"
  },
  "core": { ... },
  "profile": { ... },
  "security": { ... },
  "aliases": [ ... ],
  "global_vault": { ... }
}

B. Alias Credential Schema (uiid_alias_credential)

{
  "file_type": "uiid_alias_credential",
  "version": "2.0",
  "alias_id": "alias_9a0b1c",
  "alias_name": "Shopping Identity",
  "user_id": 1042,
  "uiid_core_id": "did:uiid:xxxx-xxxx",
  "user_email": "[email protected]",
  "exported_at": "2026-08-16T12:00:00Z",
  "kv": {
    "delivery_address": {
      "value": "123 Sovereign St",
      "is_public": false,
      "is_encrypted": true,
      "is_immutable": false
    }
  }
}

.uiid File Format