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.
GET /resolve/ark:/{naan}/{shoulder}/{date}/{token}Resolve an ARK to its record · Auth: None
POST /resolve/doisResolve DOIs in bulk · Auth: None
GET /arkLook up an ARK (query parameters) · Auth: None
GET /ark/versionsList versions of an ARK (query parameters) · Auth: None
GET /ark/check-updateCheck whether an ARK has a newer version · Auth: None
GET /ark/metadata/ark:/{naan}/{shoulder}/{date}/{token}ARK metadata · Auth: None
GET /ark/{naan}/servicestatusARK service status for a NAAN · Auth: None
GET /redirect/ark:/{naan}/{shoulder}/{date}/{token}Redirect (302) to the work's source · Auth: None
POST /nobleid/mintMint a work · Auth: Bearer or API key (mint)
POST /nobleid/mint-nobleidMint with extended fields · Auth: Bearer or API key (mint)
POST /nobleid/batch-mintMint several works · Auth: Bearer or API key (mint)
POST /nobleid/generateGenerate an identifier · Auth: Bearer or API key (mint)
POST /nobleid/createCreate a work · Auth: Bearer or API key (mint)
POST /nobleid/create-from-doiCreate from a DOI · Auth: Bearer or API key (mint)
POST /nobleid/create-from-arxivCreate from an arXiv ID · Auth: Bearer or API key (mint)
POST /nobleid/create-from-pubmedCreate from a PubMed ID · Auth: Bearer or API key (mint)
GET /nobleidList 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)
GET /public-receiptsRecent 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/worksA researcher's works (query parameters) · Auth: None
GET /user/searchSearch people · Auth: None
GET /user/researchersList researchers · Auth: None
GET /papers/searchSearch papers (requires ?query=) · Auth: None
GET /discover/recentRecently registered works · Auth: None
GET /graph/edgesCitation graph edges · Auth: None
GET /badge/{noble_id}Badge image for a NobleID · Auth: None
GET /oai?verb=IdentifyRepository information · Auth: None
GET /oai?verb=ListMetadataFormatsSupported formats · Auth: None
GET /oai?verb=ListSetsSets · Auth: None
GET /oai?verb=ListIdentifiers&metadataPrefix=oai_dcIdentifiers · Auth: None
GET /oai?verb=ListRecords&metadataPrefix=oai_dcRecords · Auth: None
GET /oai?verb=GetRecord&metadataPrefix=oai_dc&identifier={id}One record · Auth: None
POST /auth/registerRegister with email · Auth: None
POST /auth/login-with-emailSign in with email · Auth: None
POST /auth/login-with-googleSign in with Google · Auth: None
POST /auth/login-with-appleSign in with Apple · Auth: None
POST /auth/forgot-passwordRequest a password reset · Auth: None
POST /auth/reset-passwordComplete a password reset · Auth: None
POST /api-keysCreate an API key · Auth: Bearer
GET /api-keysList your API keys · Auth: Bearer
GET /api-keys/usage-logsYour 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