Registry Notary API (0.3.0)

Download OpenAPI specification:

License: Apache-2.0

Standalone claim evaluation, rendering, and credential issuance API.

Discover Registry Notary capabilities

Authorizations:

apiKeyAuthbearerAuth

Responses

Response samples

200
401

Content type

application/json

{"api_version": "2026-05",
"auth": {"api_key": {"header": "x-api-key"
},
"audience": "demo.registry-notary",
"bearer": {"format": "Bearer <token>",
"header": "Authorization",
"scheme": "bearer"
},
"methods": ["api_key",
"bearer"
]
},
"base_url": "http://127.0.0.1:4255",
"batch": {"idempotency_window": "PT15M",
"max_inline_subjects": 20
},
"claims_url": "/claims",
"credential_capabilities": {"formats": ["application/dc+sd-jwt"
],
"sd_jwt_vc": {"credential_profiles": [{"allowed_claims": ["farmer-under-4ha"
],
"disclosure": {"allowed": ["predicate"
]
},
"format": "application/dc+sd-jwt",
"holder_binding": {"allowed_did_methods": ["did:jwk"
],
"mode": "did",
"proof_of_possession": "required"
},
"id": "smallholder_sd_jwt",
"issuer": "did:web:agriculture.demo.example.gov",
"validity_seconds": 86400,
"vct": "https://demo.example.gov/credentials/smallholder-farmer/v1"
}
],
"holder_binding_methods": ["did:jwk"
],
"issuer_key_types": ["OKP/Ed25519"
],
"jwt_typ": "dc+sd-jwt",
"media_type": "application/dc+sd-jwt",
"openid4vci": {"support": "not_full_issuer"
},
"signing_algs": ["EdDSA"
],
"status_methods": [ ]
},
"unsupported_features": ["application/vc+sd-jwt",
"json_ld_vc_issuance",
"data_integrity_proofs",
"credential_status",
"mso_mdoc",
"openid4vci_full_issuer"
]
},
"formats": [{"id": "application/dc+sd-jwt",
"kind": "credential",
"status": "enabled"
},
{"id": "application/ld+json; profile=\"cccev\"",
"kind": "renderer",
"status": "enabled"
},
{"id": "application/vnd.registry-notary.claim-result+json",
"kind": "claim_result",
"status": "enabled"
}
],
"formats_url": "/formats",
"identity": {"mapper": "common_subject_id",
"production_mapper": false
},
"issuer": {"id": "did:web:agriculture.demo.example.gov",
"name": "demo.registry-notary"
},
"operations": {"batch_evaluate": true,
"credential_issue": true,
"evaluate": true,
"render": true
},
"service_id": "demo.registry-notary"
}

Fetch public issuer verification keys

Authorizations:

apiKeyAuthbearerAuth

Responses

Response samples

200
401

Content type

application/json

{"keys": [{"alg": "EdDSA",
"crv": "Ed25519",
"kid": "did:web:agriculture.demo.example.gov#registry-notary-demo-key-1",
"kty": "OKP",
"x": "11qYAYKxCrfVS_3XDbXJC2AgYI57qXzcS7P0W5Y9f4Y"
}
]
}

Discover OpenID4VCI credential issuer metadata

Returns the OpenID4VCI issuer metadata for Registry Notary' dc+sd-jwt issuance profile.

Responses

Response samples

200
500

Content type

application/json

{"authorization_servers": ["https://id.example.gov"
],
"credential_configurations_supported": {"person_is_alive_sd_jwt": {"credential_signing_alg_values_supported": ["EdDSA"
],
"cryptographic_binding_methods_supported": ["did:jwk"
],
"display": [{"name": "Person is alive"
}
],
"format": "dc+sd-jwt",
"proof_types_supported": {"jwt": {"proof_signing_alg_values_supported": ["EdDSA"
]
}
},
"scope": "person_is_alive",
"vct": "https://issuer.example.gov/credentials/person-is-alive"
}
},
"credential_endpoint": "https://issuer.example.gov/oid4vci/credential",
"credential_issuer": "https://issuer.example.gov",
"nonce_endpoint": "https://issuer.example.gov/oid4vci/nonce"
}

Request a standalone config reload

Authorizations:

apiKeyAuthbearerAuth

Responses

Response samples

200
401
403

Content type

application/json

{"detail": "standalone router has no reloadable external config handle",
"reloaded": false,
"status": "noop"
}

List claims visible to the caller

Authorizations:

apiKeyAuthbearerAuth

Responses

Response samples

200
401

Content type

application/json

{"data": [{"cccev": null,
"disclosure": {"allowed": ["value",
"redacted"
],
"default": "value",
"downgrade": "deny"
},
"formats": ["application/vnd.registry-notary.claim-result+json",
"application/ld+json; profile=\"cccev\""
],
"id": "date-of-birth",
"oots": null,
"operations": {"batch_evaluate": false,
"evaluate": true
},
"subject_type": "person",
"title": "Date of birth",
"version": "2026-05"
},
{"cccev": {"evidence_type": "smallholder_farmer_evidence",
"evidence_type_iri": "https://demo.example.gov/evidence-types/smallholder-farmer",
"requirement_type": "InformationRequirement"
},
"disclosure": {"allowed": ["predicate",
"redacted"
],
"default": "predicate",
"downgrade": "deny"
},
"evidence_type": "smallholder_farmer_evidence",
"evidence_type_iri": "https://demo.example.gov/evidence-types/smallholder-farmer",
"formats": ["application/vnd.registry-notary.claim-result+json",
"application/ld+json; profile=\"cccev\"",
"application/dc+sd-jwt"
],
"id": "farmer-under-4ha",
"oots": null,
"operations": {"batch_evaluate": true,
"evaluate": true
},
"subject_type": "person",
"title": "Farmer under four hectares",
"version": "2026-05"
}
]
}

Evaluate claims for multiple subjects inline

Authorizations:

apiKeyAuthbearerAuth

header Parameters

Idempotency-Key

string

Request Body schema: application/json
required

claims required	Array of strings
disclosure	string or null
format	string or null
purpose	string or null
required	Array of objects (SubjectRequest)

Responses

Request samples

Payload

Content type

application/json

{"claims": ["string"
],
"disclosure": "string",
"format": "string",
"purpose": "string",
"subjects": [{"id": "string",
"id_type": "string"
}
]
}

Response samples

Content type

application/json

{"batch_id": "01HX7Y4N6S7ZK0R2T8Q9V1M3PA",
"claims": ["farmer-under-4ha"
],
"items": [{"claim_results": [{"claim_id": "farmer-under-4ha",
"claim_version": "2026-05",
"disclosure": "predicate",
"provenance": {"computed_by": "demo.registry-notary",
"source_count": 1,
"source_versions": { }
},
"result_id": "01HX7Y5F31M8BZWQ2HY7P6J9FA",
"satisfied": true,
"value": true,
"value_type": "boolean"
}
],
"errors": [ ],
"evaluation_id": "01HX7Y5F2WAJ7ZP0Q4M5K9E8NC",
"input_index": 0,
"status": "succeeded",
"subject_ref": "person-1"
}
],
"status": "completed",
"summary": {"failed": 0,
"succeeded": 1
}
}

Evaluate claims for one subject

Authorizations:

apiKeyAuthbearerAuth

Request Body schema: application/json
required

claims required	Array of strings
disclosure	string or null
format	string or null
purpose	string or null
required	object (SubjectRequest)

Responses

Request samples

Payload

Content type

application/json

{"claims": ["string"
],
"disclosure": "string",
"format": "string",
"purpose": "string",
"subject": {"id": "string",
"id_type": "string"
}
}

Response samples

Content type

application/json

{"results": [{"claim_id": "farmer-under-4ha",
"claim_version": "2026-05",
"disclosure": "predicate",
"evaluation_id": "01HX7Y5F2WAJ7ZP0Q4M5K9E8NC",
"expires_at": "2026-05-25T12:00:00Z",
"format": "application/vnd.registry-notary.claim-result+json",
"issued_at": "2026-05-24T12:00:00Z",
"provenance": {"computed_by": "demo.registry-notary",
"source_count": 1,
"source_versions": { }
},
"satisfied": true,
"subject_ref": "person-1",
"subject_type": "person",
"value": true
}
]
}

Get one claim definition

Authorizations:

apiKeyAuthbearerAuth

path Parameters

claim_id

required

string

Responses

Response samples

200
401
404

Content type

application/json

{"cccev": {"evidence_type": "smallholder_farmer_evidence",
"evidence_type_iri": "https://demo.example.gov/evidence-types/smallholder-farmer",
"requirement_type": "InformationRequirement"
},
"disclosure": {"allowed": ["predicate",
"redacted"
],
"default": "predicate",
"downgrade": "deny"
},
"evidence_type": "smallholder_farmer_evidence",
"evidence_type_iri": "https://demo.example.gov/evidence-types/smallholder-farmer",
"formats": ["application/vnd.registry-notary.claim-result+json",
"application/ld+json; profile=\"cccev\"",
"application/dc+sd-jwt"
],
"id": "farmer-under-4ha",
"oots": null,
"operations": {"batch_evaluate": true,
"evaluate": true
},
"subject_type": "person",
"title": "Farmer under four hectares",
"version": "2026-05"
}

Issue a credential from a stored evaluation

Authorizations:

apiKeyAuthbearerAuth

Request Body schema: application/json
required

claims	Array of strings or null
credential_profile	string or null
disclosure	string or null
evaluation_id required	string
format	string or null
	null or HolderRequest (object)

Responses

Request samples

Payload

Content type

application/json

{"claims": ["string"
],
"credential_profile": "string",
"disclosure": "string",
"evaluation_id": "string",
"format": "string",
"holder": { }
}

Response samples

Content type

application/json

{"credential": "eyJhbGciOiJFZERTQSIsInR5cCI6ImRjK3NkLWp3dCIsImtpZCI6ImRpZDp3ZWI6YWdyaWN1bHR1cmUuZGVtby5leGFtcGxlLmdvdiNyZWdpc3RyeS13aXRuZXNzLWRlbW8ta2V5LTEifQ.eyJpc3MiOiJkaWQ6d2ViOmFncmljdWx0dXJlLmRlbW8uZXhhbXBsZS5nb3YiLCJzdWIiOiJkaWQ6andrOmV5SnJkSGtpT2lKUFMxQWlMQ0pqY25ZaU9pSkZaREkxTlRFNUlpd2llQ0k2SWpFeGNWbEJXVXQ0UTNKbVZsTmZNMWhFWWxoS1F6SkJaMWxKTlRkeFdIcGpVemRRTUZjMVdUbG1ORmtpZlEiLCJpYXQiOjE3Nzk2MjQwMDAsImV4cCI6MTc3OTcxMDQwMCwidmN0IjoiaHR0cHM6Ly9kZW1vLmV4YW1wbGUuZ292L2NyZWRlbnRpYWxzL3NtYWxsaG9sZGVyLWZhcm1lci92MSIsImp0aSI6InVybjpyZWdpc3RyeS13aXRuZXNzOmNyZWRlbnRpYWw6MDFIWDdZNUYyV0FKN1pQMFE0TTVLOUU4TkMiLCJpZCI6InVybjpyZWdpc3RyeS13aXRuZXNzOmNyZWRlbnRpYWw6MDFIWDdZNUYyV0FKN1pQMFE0TTVLOUU4TkMiLCJfc2QiOlsia0ZxYXpKcDdleVhjS1ZIX0tiMzNnQ1lwMGM3dzFDLWd0WjVORkJxbDdYcyJdLCJjbmYiOnsia2lkIjoiZGlkOmp3azpleUpyZEhraU9pSlBTMUFpTENKamNuWWlPaUpGWkRJMU5URTVJaXdpZUNJNklqRXhjVmxCV1V0NFEzSm1WbE5mTTFoRVlsaEtRekpCWjFsSk5UZHhXSHBqVXpkUU1GYzFXVGxtTkZraWZRIiwiandrIjp7Imt0eSI6Ik9LUCIsImNydiI6IkVkMjU1MTkiLCJ4IjoiMTFxWUFZS3hDcmZWU18zWERiWEpDMkFnWUk1N3FYemNTN1AwVzVZOWY0WSJ9fX0.c2lnbmF0dXJl~ZGlzY2xvc3VyZQ~",
"credential_id": "urn:registry-notary:credential:01HX7Y5F2WAJ7ZP0Q4M5K9E8NC",
"disclosures": ["ZGlzY2xvc3VyZQ"
],
"expires_at": "2026-05-25T12:00:00Z",
"format": "application/dc+sd-jwt",
"issuer": "did:web:agriculture.demo.example.gov",
"issuer_signed_jwt": "eyJhbGciOiJFZERTQSIsInR5cCI6ImRjK3NkLWp3dCIsImtpZCI6ImRpZDp3ZWI6YWdyaWN1bHR1cmUuZGVtby5leGFtcGxlLmdvdiNyZWdpc3RyeS13aXRuZXNzLWRlbW8ta2V5LTEifQ.eyJpc3MiOiJkaWQ6d2ViOmFncmljdWx0dXJlLmRlbW8uZXhhbXBsZS5nb3YiLCJzdWIiOiJkaWQ6andrOmV5SnJkSGtpT2lKUFMxQWlMQ0pqY25ZaU9pSkZaREkxTlRFNUlpd2llQ0k2SWpFeGNWbEJXVXQ0UTNKbVZsTmZNMWhFWWxoS1F6SkJaMWxKTlRkeFdIcGpVemRRTUZjMVdUbG1ORmtpZlEiLCJpYXQiOjE3Nzk2MjQwMDAsImV4cCI6MTc3OTcxMDQwMCwidmN0IjoiaHR0cHM6Ly9kZW1vLmV4YW1wbGUuZ292L2NyZWRlbnRpYWxzL3NtYWxsaG9sZGVyLWZhcm1lci92MSIsImp0aSI6InVybjpyZWdpc3RyeS13aXRuZXNzOmNyZWRlbnRpYWw6MDFIWDdZNUYyV0FKN1pQMFE0TTVLOUU4TkMiLCJpZCI6InVybjpyZWdpc3RyeS13aXRuZXNzOmNyZWRlbnRpYWw6MDFIWDdZNUYyV0FKN1pQMFE0TTVLOUU4TkMiLCJfc2QiOlsia0ZxYXpKcDdleVhjS1ZIX0tiMzNnQ1lwMGM3dzFDLWd0WjVORkJxbDdYcyJdLCJjbmYiOnsia2lkIjoiZGlkOmp3azpleUpyZEhraU9pSlBTMUFpTENKamNuWWlPaUpGWkRJMU5URTVJaXdpZUNJNklqRXhjVmxCV1V0NFEzSm1WbE5mTTFoRVlsaEtRekpCWjFsSk5UZHhXSHBqVXpkUU1GYzFXVGxtTkZraWZRIiwiandrIjp7Imt0eSI6Ik9LUCIsImNydiI6IkVkMjU1MTkiLCJ4IjoiMTFxWUFZS3hDcmZWU18zWERiWEpDMkFnWUk1N3FYemNTN1AwVzVZOWY0WSJ9fX0.c2lnbmF0dXJl"
}

Render a stored evaluation

Authorizations:

apiKeyAuthbearerAuth

Request Body schema: application/json
required

claims	Array of strings or null
disclosure	string or null
evaluation_id required	string
format required	string
purpose	string or null

Responses

Request samples

Payload

Content type

application/json

{"claims": ["string"
],
"disclosure": "string",
"evaluation_id": "string",
"format": "string",
"purpose": "string"
}

Response samples

Content type

application/json

{"results": [{"claim_id": "farmer-under-4ha",
"claim_version": "2026-05",
"disclosure": "predicate",
"evaluation_id": "01HX7Y5F2WAJ7ZP0Q4M5K9E8NC",
"expires_at": "2026-05-25T12:00:00Z",
"format": "application/vnd.registry-notary.claim-result+json",
"issued_at": "2026-05-24T12:00:00Z",
"provenance": {"computed_by": "demo.registry-notary",
"source_count": 1,
"source_versions": { }
},
"satisfied": true,
"subject_ref": "person-1",
"subject_type": "person",
"value": true
}
]
}

Evaluate one configured federation profile for a trusted peer

Accepts a compact JWS request with typ registry-notary-request+jwt. This route is mounted only when federation is enabled and uses body-JWT authentication instead of API key or bearer authentication.

Request Body schema: application/jwt
required

string

Compact JWS signed federation evaluation request

Responses

List supported output formats

Authorizations:

apiKeyAuthbearerAuth

Responses

Response samples

200
401

Content type

application/json

{"formats": [{"id": "application/dc+sd-jwt",
"kind": "credential",
"status": "enabled"
},
{"id": "application/ld+json; profile=\"cccev\"",
"kind": "renderer",
"status": "enabled"
},
{"id": "application/vnd.registry-notary.claim-result+json",
"kind": "claim_result",
"status": "enabled"
}
]
}

Return the liveness probe

Responses

Response samples

200
4XX

Content type

application/json

{"checks": {"failed": 0,
"ok": 1,
"total": 1
},
"status": "ok"
}

Issue a credential through OpenID4VCI

Issues a dc+sd-jwt credential for an authenticated self-attestation principal. Error responses use the OpenID4VCI error envelope, not RFC 7807 Problem Details.

Authorizations:

bearerAuth

Request Body schema: application/json
required

credential_configuration_id	string
credential_identifier	string
format required	string
required	object
vct	string <uri>

Responses

Request samples

Payload

Content type

application/json

{"credential_configuration_id": "string",
"credential_identifier": "string",
"format": "dc+sd-jwt",
"proof": {"jwt": "string",
"proof_type": "jwt"
},
"vct": "http://example.com"
}

Response samples

Content type

application/json

{"c_nonce": "next-b64url-nonce",
"c_nonce_expires_in": 300,
"credential": "eyJhbGciOiJFZERTQSIsInR5cCI6ImRjK3NkLWp3dCJ9.payload.signature~disclosure~",
"format": "dc+sd-jwt"
}

Create an OpenID4VCI credential offer

Returns an authorization-code credential offer. Error responses use the OpenID4VCI error envelope, not RFC 7807 Problem Details.

query Parameters

credential_configuration_id

string

Responses

Response samples

200
400
500

Content type

application/json

{"credential_configuration_ids": ["person_is_alive_sd_jwt"
],
"credential_issuer": "https://issuer.example.gov",
"grants": {"authorization_code": {"authorization_server": "https://id.example.gov",
"issuer_state": "issuer-state"
}
}
}

Create an OpenID4VCI credential nonce

Returns a c_nonce for proof-of-possession. Error responses use the OpenID4VCI error envelope, not RFC 7807 Problem Details.

Request Body schema: application/json
optional

credential_configuration_id

string

Responses

Request samples

Payload

Content type

application/json

{"credential_configuration_id": "string"
}

Response samples

200
400
429
500

Content type

application/json

{"c_nonce": "b64url-nonce",
"c_nonce_expires_in": 300
}

Fetch this OpenAPI document

Authorizations:

apiKeyAuthbearerAuth

Responses

Response samples

200
401

Content type

application/json

{"info": {"title": "Registry Notary API",
"version": "0.3.0"
},
"openapi": "3.1.0",
"paths": {"/claims/evaluate": { }
}
}

Return the readiness probe

Responses

Response samples

200
503
4XX

Content type

application/json

{"checks": {"failed": 0,
"ok": 1,
"total": 1
},
"status": "ready"
}

Registry Notary API (0.3.0)

Discover Registry Notary capabilities

Authorizations:

Responses

Response samples

Fetch public issuer verification keys

Authorizations:

Responses

Response samples

Discover OpenID4VCI credential issuer metadata

Responses

Response samples

Request a standalone config reload

Authorizations:

Responses

Response samples

List claims visible to the caller

Authorizations:

Responses

Response samples

Evaluate claims for multiple subjects inline

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Evaluate claims for one subject

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get one claim definition

Authorizations:

path Parameters

Responses

Response samples

Issue a credential from a stored evaluation

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Render a stored evaluation

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Evaluate one configured federation profile for a trusted peer

Request Body schema: application/jwtrequired

Responses

List supported output formats

Authorizations:

Responses

Response samples

Return the liveness probe

Responses

Response samples

Issue a credential through OpenID4VCI

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Create an OpenID4VCI credential offer

query Parameters

Responses

Response samples

Create an OpenID4VCI credential nonce

Request Body schema: application/jsonoptional

Responses

Request samples

Response samples

Fetch this OpenAPI document

Authorizations:

Responses

Response samples

Return the readiness probe

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/jwt
required

Request Body schema: application/json
required

Request Body schema: application/json
optional