Developers

Build With ArkID

ArkID is open identity infrastructure for research and innovation, and the developer platform behind its identifiers, relationships, resolver, and integrations is entering public preview.

If you are building systems that need durable identity, traceable relationships, and interoperable records across research and innovation workflows, ArkID is designed to be integrated, extended, and improved in the open.

Public Preview — core services are being hardened for public use. Documentation reflects current architecture and explicitly labeled roadmap items.

Current status

What Is Live, What Is in Preview, What Is Next

In flight

Core identity infrastructure
Relational data model
Resolver behavior
Documentation migration
Contributor onboarding

Public Preview focus

Identifier generation and validation
Public resolver
Core relationship model
Schema documentation
Early integration patterns

Next priorities

Expanded import pipelines
Hardened security and verification flows
Public repository consolidation
Additional federation and credential workflows

ArkID is being developed in public, but not every planned capability is production-ready. We separate current functionality from roadmap items throughout the developer experience.

What developers build with

Core Developer Surfaces

Identifier model

Work with standardized identifiers across the full research and innovation graph.

Relationship model

Model affiliations, authorship, participation, stewardship, funding, and other time-aware relationships.

Resolver

Resolve ArkIDs through public URLs and use stable entity references across systems.

APIs

Use REST and GraphQL interfaces to access entity data, relationships, and integrations.

Schemas

Build against documented entity schemas for users, organizations, projects, funding, ideas, and outputs.
Architecture

ArkID Architecture at a Glance

ArkID is designed as modular, open infrastructure.

Core infrastructure

Keycloak-based identity foundations
Relational storage for identities and relationships
Public resolver services
Versioned schema and integration surfaces

Integration layer

REST and GraphQL APIs
External identifier integrations
ETL and import workflows
Resolver and public profile surfaces

Trust foundations

Standards-based identifier model
Federation and authentication support
Verifiable Credentials on the roadmap
Governance and sovereignty constraints

The architecture is designed to support institutional adoption without making ArkID dependent on one platform or one deployment model.

Quick start

Get Ready to Work With ArkID

Prerequisites

  • Docker and Docker Compose

    For running Keycloak, PostgreSQL, and other services

  • Node.js and Bun

    Preferred tooling for Next.js and monorepo workflows

  • TypeScript familiarity

    Modern TypeScript-based service and frontend workflows throughout

High-Level Setup

git clone https://github.com/ArkID-by-ResearchArk/arkid.git
cd arkid
docker compose up -d
bun install
bun run dev:frontend

If the main organisation repositories are not yet public, use the current docs and contact channels to coordinate access, reference materials, or contribution pathways.

Project structure

Where Things Live

Backend

Configuration, middleware, routes, services, schemas, and identity logic.

Frontend

App routes, reusable components, utilities, and public-facing interfaces.

Identity and infrastructure

Keycloak configuration, deployment assets, service orchestration, and environment setup.

Documentation

Schemas, specifications, guides, and contribution materials.

The public documentation is your entry point. Repository structure becomes easier to navigate once you understand ArkID's entity model and relationship model.

Contributing

Help Shape ArkID

ArkID is being built as open infrastructure, and contributions are welcome as the public preview matures.

Good ways to contribute

Improve schemas and schema guides
Strengthen resolver behavior and data modeling
Improve integrations and import logic
Clarify documentation and onboarding
Help shape governance and developer workflows

Contribution flow

  1. 1
    Find an issue or start a discussion
  2. 2
    Fork the relevant repository
  3. 3
    Create a branch for your work
  4. 4
    Implement changes with tests where appropriate
  5. 5
    Submit a pull request with clear context

Where process is still evolving, we prefer clarity and discussion over silent assumptions.

Resources

Developer Resources

Integration specifications
JSON schemas
API reference
Contributing guide
Schema documentation

Detailed references will be published alongside the public repository launch. Schema documentation is available now.

Read the Docs
Contact

Questions, Feedback, or Integration Plans?

If you are evaluating ArkID, planning an integration, or want to contribute during public preview, reach out directly.