Skip to content
Registry StackDocsDocumentation preview
Search

Get one claim definition

GET
/v1/claims/{claim_id}
curl --request GET \
  --url https://example.com/v1/claims/example \
  --header 'X-Api-Key: <X-Api-Key>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
claim_id
required
string

Responses

Section titled “Responses”

200

Section titled “200”

Claim definition

Media typeapplication/json
object
cccev
One of:
null
disclosure
required
object
allowed
required
Array<string>
default
required
string
downgrade
required
string
evidence_type
string
evidence_type_iri
string format: uri
formats
required
Array<string>
id
required
string
oots
One of:
null
operations
required
object
batch_evaluate
required
boolean
evaluate
required
boolean
semantics

Optional semantic binding for a Notary claim. These fields label the claim output or predicate with external vocabulary terms such as PublicSchema URIs; they do not change the Notary result shape or by themselves prove privacy minimization.

object
concept

External concept URI, for example https://publicschema.org/Person.

string
derived_from

External property URIs the predicate or derived value depends on.

Array<string>
predicate

External or local predicate URI/URN for derived boolean claims.

string
property

External property URI for raw value claims, for example https://publicschema.org/date_of_birth.

string
value_mapping

Operator label for the value mapping/canonicalization applied before returning the claim.

string
vocabulary

External vocabulary or value-set URI used by the claim value.

string
subject_type
required
string
target_inputs

Safe request-input metadata for building evaluation targets. It exposes target-side paths and matching method labels, never upstream connection, dataset, entity, or field details.

Array<object>
object
confidence
required

Policy-asserted confidence label for this target-input method.

string
groups
required

OR-of-AND input groups. A request needs to satisfy one group.

Array<object>
object
inputs
required
Array<object>
object
kind
required
string
Allowed values: id identifier attribute
label
required
string
name
required
string
path
required

Target-side request path, for example target.identifiers.national_id or target.attributes.birthdate.

string
method
required

Configured target-matching method label.

string
policy_id

Stable target-matching policy identifier when configured.

string
target_type
required
string
title
required
string
version
required
string
key
additional properties
any
Example
{
  "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\""
  ],
  "id": "farmer-under-4ha",
  "oots": null,
  "operations": {
    "batch_evaluate": true,
    "evaluate": true
  },
  "subject_type": "person",
  "target_inputs": [
    {
      "confidence": "high",
      "groups": [
        {
          "inputs": [
            {
              "kind": "identifier",
              "label": "Farmer id",
              "name": "farmer_id",
              "path": "target.identifiers.farmer_id"
            }
          ]
        },
        {
          "inputs": [
            {
              "kind": "attribute",
              "label": "Given name",
              "name": "given_name",
              "path": "target.attributes.given_name"
            },
            {
              "kind": "attribute",
              "label": "Family name",
              "name": "family_name",
              "path": "target.attributes.family_name"
            },
            {
              "kind": "attribute",
              "label": "Birthdate",
              "name": "birthdate",
              "path": "target.attributes.birthdate"
            }
          ]
        }
      ],
      "method": "exact_name_birthdate",
      "policy_id": "smallholder-demographic-v1",
      "target_type": "Person"
    }
  ],
  "title": "Farmer under four hectares",
  "version": "2026-05"
}

401

Section titled “401”

Missing or invalid credential

Media typeapplication/problem+json
object
code
required
string
detail
required
string
request_id
required
string
status
required
integer format: int32
title
required
string
type
required
string format: uri
key
additional properties
any
Example
{
  "code": "auth.missing_credential",
  "detail": "missing authentication credential",
  "request_id": "01J00000000000000000000000",
  "status": 401,
  "title": "Missing credential",
  "type": "https://id.registrystack.org/problems/registry-notary/auth/missing_credential"
}

404

Section titled “404”

Claim not found

Media typeapplication/problem+json
object
code
required
string
detail
required
string
request_id
required
string
status
required
integer format: int32
title
required
string
type
required
string format: uri
key
additional properties
any
Example
{
  "code": "claim.not_found",
  "detail": "the requested claim is not available",
  "request_id": "01J00000000000000000000000",
  "status": 404,
  "title": "Claim not found",
  "type": "https://id.registrystack.org/problems/registry-notary/claim/not_found"
}