Shared Vocabulary Layer

ArkID Reference Catalogue Schema

Central catalogue of ArkID identifier patterns, EC-aligned controlled vocabularies, and helper formats that every downstream schema references.

Version

0.2.0

Last Updated

2025-10-31

Alignment

EC Partnership Template v2.5 & ArkID identifier policy

Source Schema

docs/schemas/arkid_reference_catalogue.schema.json

Highlights

  • Exports canonical regex definitions for all ArkID entity identifiers (ARKI/ARKU/ARKO/ARKP/ARKD/ARKF).
  • Bundles EC partnership taxonomies including action types, partnership status, KPI codes, and RIS-related flags.
  • Ships reusable format helpers for EC dates, ISO country codes, PIC numbers, and ArkID-specific enums.

When to Use

  • Validating upstream payloads before issuing ArkID identifiers.
  • Hydrating dropdowns in UI workflows with EC-certified enumerations.
  • Sharing a single vocabulary snapshot across microservices to guarantee DRY schema evolution.

Identifier Patterns

Regex-backed helpers enforce ArkID ISO-27729 formatting across all entity types.

$defs.arkidIdentifier

string (regex)Required

Generic catch-all pattern (ARK[UOPKDF]-0000-0000-0000-000X) used by shared tooling before narrowing to entity-specific identifiers.

$defs.arkfIdentifier / arkpIdentifier / arkoIdentifier…

string (regex)Required

Entity-specific specialisations used by funding, project, organisation, idea, product, and user schemas.

$defs.picNumber / picString

number|stringOptional

EC participant identification code format, exposed in both numeric and string representations for compatibility.

Controlled Vocabularies

Enumerations synchronised with the 2024-06-26 EC partnership template.

  • partnershipName & partnershipType cover the EC master list of institutional partnerships.
  • actionType, eitActivityCategory, and eitArea align to the EIT KAVA classification.
  • participantRole, participantType, and stageExitStatus support EC reporting on cascading grants.
  • genderCode, careerStage, contributionScale, and coreKpiArea deliver people-centric enumerations.

Format Helpers

Reusable primitive definitions to keep downstream schemas concise.

$defs.countryCode

string (ISO-3166-1 alpha-2)Required

Two-letter country codes applied to organisations, participants, and researchers.

$defs.ecDate

string (date)Required

YYYY-MM-DD formatted date used across EC-aligned schemas (start, end, signature, deadlines).

$defs.ecEmail

string (pattern)Recommended

EC-compliant email validation pattern for contacts and participants.

Key catalogue fragments

Reference implementation of identifier patterns and EC partnership enums.

{
  "arkidIdentifierPattern": "^(ARK[UOPKDF])-\d{4}-\d{4}-\d{4}-\d{3}[0-9X]$",
  "partnershipTypes": [
    "CO-FUNDED",
    "CO-PROGRAMMED",
    "INSTITUTIONALISED"
  ],
  "yesNo": [
    "Yes",
    "No"
  ]
}