API Reference

OpenAPI served here; endpoints list on left

This reference lists only endpoints that exist in the NobleID API today. Base URL: https://api.nobleid.org/api/v1.

Paths below are relative to the base URL. {naan} is your ARK authority number; read it from a resolved ARK rather than hardcoding it. Send a Bearer token as Authorization: Bearer <token> or an API key as X-API-Key: <key>. An API key can only mint, update and read works; every other signed-in endpoint needs a session token.

Resolve and ARK reads
Public, no authentication.
GET /resolve/ark:/{naan}/{shoulder}/{date}/{token}

Resolve an ARK to its record · Auth: None

POST /resolve/dois

Resolve DOIs in bulk · Auth: None

GET /ark

Look up an ARK (query parameters) · Auth: None

GET /ark/versions

List versions of an ARK (query parameters) · Auth: None

GET /ark/check-update

Check whether an ARK has a newer version · Auth: None

GET /ark/metadata/ark:/{naan}/{shoulder}/{date}/{token}

ARK metadata · Auth: None

GET /ark/{naan}/servicestatus

ARK service status for a NAAN · Auth: None

GET /redirect/ark:/{naan}/{shoulder}/{date}/{token}

Redirect (302) to the work's source · Auth: None

Works (register and manage)
Create, read, update and delete works. Writes need a Bearer token, or an API key with the matching scope (mint, update, read).
POST /nobleid/mint

Mint a work · Auth: Bearer or API key (mint)

POST /nobleid/mint-nobleid

Mint with extended fields · Auth: Bearer or API key (mint)

POST /nobleid/batch-mint

Mint several works · Auth: Bearer or API key (mint)

POST /nobleid/generate

Generate an identifier · Auth: Bearer or API key (mint)

POST /nobleid/create

Create a work · Auth: Bearer or API key (mint)

POST /nobleid/create-from-doi

Create from a DOI · Auth: Bearer or API key (mint)

POST /nobleid/create-from-arxiv

Create from an arXiv ID · Auth: Bearer or API key (mint)

POST /nobleid/create-from-pubmed

Create from a PubMed ID · Auth: Bearer or API key (mint)

GET /nobleid

List your own works · Auth: Bearer or API key (read)

GET /nobleid/ark:/{naan}/{shoulder}/{date}/{token}

Get one work (optional ?version=). Without a key, use GET /ark · Auth: Bearer or API key (read)

GET /nobleid/versions/ark:/{naan}/{shoulder}/{date}/{token}

List a work's versions. Without a key, use GET /ark/versions · Auth: Bearer or API key (read)

PUT /nobleid/ark:/{naan}/{shoulder}/{date}/{token}

Update a work · Auth: Bearer or API key (update)

DELETE /nobleid/ark:/{naan}/{shoulder}/{date}/{token}

Delete a work · Auth: Bearer or API key (update)

Receipts and public reads
Public, no authentication.
GET /public-receipts

Recent public receipts (limit up to 100, offset) · Auth: None

GET /user/{id}

Public profile by id or NobleID · Auth: None

GET /user/username/{username}

Public profile by username · Auth: None

GET /user/works

A researcher's works (query parameters) · Auth: None

GET /user/search

Search people · Auth: None

GET /user/researchers

List researchers · Auth: None

GET /papers/search

Search papers (requires ?query=) · Auth: None

GET /discover/recent

Recently registered works · Auth: None

GET /graph/edges

Citation graph edges · Auth: None

GET /badge/{noble_id}

Badge image for a NobleID · Auth: None

OAI-PMH
Standard OAI-PMH harvesting endpoint. Only the oai_dc metadata format is supported.
GET /oai?verb=Identify

Repository information · Auth: None

GET /oai?verb=ListMetadataFormats

Supported formats · Auth: None

GET /oai?verb=ListSets

Sets · Auth: None

GET /oai?verb=ListIdentifiers&metadataPrefix=oai_dc

Identifiers · Auth: None

GET /oai?verb=ListRecords&metadataPrefix=oai_dc

Records · Auth: None

GET /oai?verb=GetRecord&metadataPrefix=oai_dc&identifier={id}

One record · Auth: None

Sign-in and API keys
Sign in to get a Bearer token. API keys are created and managed with a signed-in session (an API key cannot manage keys).
POST /auth/register

Register with email · Auth: None

POST /auth/login-with-email

Sign in with email · Auth: None

POST /auth/login-with-google

Sign in with Google · Auth: None

POST /auth/login-with-apple

Sign in with Apple · Auth: None

POST /auth/forgot-password

Request a password reset · Auth: None

POST /auth/reset-password

Complete a password reset · Auth: None

POST /api-keys

Create an API key · Auth: Bearer

GET /api-keys

List your API keys · Auth: Bearer

GET /api-keys/usage-logs

Your API key usage logs · Auth: Bearer

GET /api-keys/{id}

Get one API key · Auth: Bearer

DELETE /api-keys/{id}

Revoke an API key · Auth: Bearer

    ByNobleID