API Documentation

List Standards

GET /api/v1/standards

Get a paginated list of technical standards and specifications with optional search and project inclusion. Includes W3C specifications, ISO standards, and other technical frameworks relevant to digital identity.

Request

Query Parameters

Parameter Type Required Default Description
page integer No 1 Page number (1-indexed)
per_page integer No 20 Results per page (1-100)
q string No - Search text for standard titles
include_projects boolean No false Include list of all projects following each standard

Example Requests

bash
# Get first page of standards
curl -X GET "https://www.weboftrust.org/api/v1/standards" \
  -H "X-API-Key: YOUR_API_KEY"

# Search for W3C standards
curl -X GET "https://www.weboftrust.org/api/v1/standards?q=W3C" \
  -H "X-API-Key: YOUR_API_KEY"

# Get standards with their implementing projects
curl -X GET "https://www.weboftrust.org/api/v1/standards?include_projects=true" \
  -H "X-API-Key: YOUR_API_KEY"

# Get page 2 with 50 results per page
curl -X GET "https://www.weboftrust.org/api/v1/standards?page=2&per_page=50" \
  -H "X-API-Key: YOUR_API_KEY"

Response

Success Response (200 OK)

Response Schema

typescript
interface StandardListResponse {
  data: StandardSummary[];
  pagination: {
    page: number;       // Current page (1-indexed)
    per_page: number;   // Items per page
    total: number;      // Total number of standards
    total_pages: number; // Total number of pages
  };
}

interface StandardSummary {
  id: number;
  title: string;
  url?: string;         // Official specification URL
  stats: {
    total_links: number; // Number of projects following this standard
  };
  projects?: ProjectUsage[];  // Only included when include_projects=true (all projects)
}

interface ProjectUsage {
  id: number;
  title: string;
  type: "DID Project" | "Consortium";
  website?: string;
  source?: string;    // URL confirming project follows this standard
}

Example Response (without projects)

json
{
  "data": [
    {
      "id": 12,
      "title": "W3C Verifiable Credentials Data Model",
      "url": "https://www.w3.org/TR/vc-data-model/",
      "stats": {
        "total_links": 215
      }
    },
    {
      "id": 3,
      "title": "W3C Decentralized Identifiers (DIDs)",
      "url": "https://www.w3.org/TR/did-core/",
      "stats": {
        "total_links": 184
      }
    },
    {
      "id": 45,
      "title": "ISO/IEC 18013-5:2021 mDL",
      "url": "https://www.iso.org/standard/69084.html",
      "stats": {
        "total_links": 67
      }
    },
    {
      "id": 78,
      "title": "OpenID Connect",
      "url": "https://openid.net/connect/",
      "stats": {
        "total_links": 89
      }
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 4,
    "total": 88,
    "total_pages": 22
  }
}

Example Response (with projects)

json
{
  "data": [
    {
      "id": 12,
      "title": "W3C Verifiable Credentials Data Model",
      "url": "https://www.w3.org/TR/vc-data-model/",
      "stats": {
        "total_links": 215
      },
      "projects": [
        {
          "id": 118,
          "title": "TradeTrust",
          "type": "DID Project",
          "website": "https://www.tradetrust.io/",
          "source": "https://archive.li/UpHV3#52%"
        },
        {
          "id": 149,
          "title": "AU10TIX Reusable Digital ID",
          "type": "DID Project",
          "website": "https://www.au10tix.com/",
          "source": "https://archive.ph/cUVfv"
        },
        {
          "id": 325,
          "title": "EU Digital Identity Wallet",
          "type": "DID Project",
          "website": "https://ec.europa.eu/digital-building-blocks/sites/display/EUDIGITALIDENTITYWALLET/EU+Digital+Identity+Wallet+Home",
          "source": "https://did-map-resources.s3.amazonaws.com/Western+Europe/EU+Digital+Identity+Wallet/ARF_v100_for_publication_SqMV8FwSeE3xg7teicYY4hFDY_93678.pdf"
        }
      ]
    },
    {
      "id": 3,
      "title": "W3C Decentralized Identifiers (DIDs)",
      "url": "https://www.w3.org/TR/did-core/",
      "stats": {
        "total_links": 184
      },
      "projects": [
        {
          "id": 237,
          "title": "Hyland Experience Credentials",
          "type": "DID Project",
          "website": "https://www.hyland.com/en/products/hyland-experience-credentials",
          "source": "https://archive.ph/3dNhH#selection-305.0-305.291"
        }
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 2,
    "total": 88,
    "total_pages": 44
  }
}

Error Responses

400 Bad Request

Invalid query parameters

json
{
  "error": {
    "code": "invalid_parameter",
    "message": "Invalid page parameter"
  }
}

500 Internal Server Error

json
{
  "error": {
    "code": "internal_error",
    "message": "Failed to fetch standards"
  }
}

Field Descriptions

  • title: Official name of the standard or specification
  • url: Link to the official specification document
  • stats.total_links: Number of projects implementing or following this standard