User (ARKU)

ArkID User Schema

Models researcher identities in ArkID, including verification state, organisational affiliations, and external identifier links.

Version

1.1.0

Last Updated

2025-04-25

Alignment

ArkID identity profile

Source Schema

docs/schemas/arkid_user_schema.json

Highlights

  • Supports ISO-27729 compliant ArkID identifiers alongside ORCID, ISNI, and ROR crosswalks.
  • Stores verification state for future W3C Verifiable Credential issuance.
  • Allows multiple organisation affiliations with role and start/end dates.

When to Use

  • Provisioning user accounts in Keycloak with enriched identity metadata.
  • Displaying researcher profiles on ArkID public pages.
  • Linking identities to products, projects, and ideas for provenance tracking.

Identity Basics

Core personal attributes required across ArkID.

arkidUser

string (ARKU identifier)Optional

Generated once the user is registered; drafts can omit.

name.firstName / name.lastName

stringRequired

Legal names used for certificates and credentials.

verificationStatus

string (enum)Required

Tracks platform verification (Pending, Verified, Suspended).

Affiliations

Links to organisations and roles held.

associatedOrganizations[]

arrayRecommended

Each entry records the ARKO identifier, role, and active dates.

expertiseKeywords

array[string]Optional

Used for discovery and matchmaking.

External Identifiers

Optional but crucial for interoperability.

  • externalIds.orcid validates ORCID iDs for credential issuance.
  • externalIds.isni / scopusAuthorId / googleScholar capture additional registry links.
  • preferredContact contains email/phone addresses referencing ecEmail pattern.

Researcher profile snapshot

{
  "arkidUser": "ARKU-2024-0001-0002-0001",
  "name": {
    "firstName": "Helena",
    "lastName": "Lange"
  },
  "verificationStatus": "Verified",
  "associatedOrganizations": [
    {
      "arkidOrg": "ARKO-2024-0001-0002-0001",
      "associationStartDate": "2024-01-01",
      "role": "Research Lead"
    }
  ]
}