Evidence offering metadata

GET

/metadata/evidence-offerings/{offering_id}

const url = 'https://data.example.test/metadata/evidence-offerings/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://data.example.test/metadata/evidence-offerings/example \
  --header 'Authorization: Bearer <token>'

Returns one visible evidence offering. Unknown, hidden, and unauthorized offerings return offering.not_found.

Authorizations

bearerAuth
apiKeyAuth

Parameters

Path Parameters

offering_id

required

string

Evidence offering identifier

Responses

200

Successful response

application/json

object

access

required

object

conforms_to

string | null format: uri

discovery_url

string | null format: uri

endpoint_url

string | null format: uri

href

string

kind

required

string

Allowed values: registry-notary

ruleset

required

string

key

additional properties

any

dataset_id

required

string

description

string | null

entity

required

string

evidence_type

required

object

key

additional properties

any

required

string

iri

string | null format: uri

issuing_authority

required

object

key

additional properties

any

jurisdiction

object | null

level_of_assurance

string | null

lookup_keys

required

Array<string>

policy

object | null

procedure_contexts

Array<string>

requirement

object | null

title

required

string

verification_request_schema_url

required

string format: uri

key

additional properties

any

Examples

evidence_offering

Evidence offering discovery record.

{
  "access": {
    "conforms_to": "https://demo.example.gov/standards/registry-notary/evidence-v1",
    "discovery_url": "https://notary.demo.example.gov/.well-known/registry-notary",
    "endpoint_url": "https://notary.demo.example.gov/evidence-offerings/benefits-person/verifications",
    "kind": "registry-notary",
    "ruleset": "benefits-person-v1"
  },
  "dataset_id": "benefits_casework",
  "description": "Registry Notary verification for submitted benefits person eligibility status and role facts.",
  "entity": "person",
  "evidence_type": {
    "id": "benefits_person_record_evidence",
    "iri": "https://demo.example.gov/evidence-types/benefits-person-record",
    "name": "Benefits person record evidence"
  },
  "evidence_type_iri": "https://demo.example.gov/evidence-types/benefits-person-record",
  "id": "benefits_person_evidence",
  "information_concepts": [],
  "iri": "https://demo.example.gov/evidence-offerings/benefits-person",
  "issuing_authority": {
    "country": "ZZ",
    "id": "ministry_of_social_affairs",
    "iri": "did:web:social-affairs.demo.example.gov",
    "name": "Ministry of Social Affairs"
  },
  "jurisdiction": {
    "country": "ZZ",
    "region": null
  },
  "level_of_assurance": "substantial",
  "lookup_keys": [
    "id"
  ],
  "policy": {
    "purpose": [
      "https://demo.example.gov/purpose/social-protection-eligibility"
    ]
  },
  "procedure_contexts": [],
  "requirement_iris": [
    "https://demo.example.gov/requirements/benefits-person"
  ],
  "title": "Benefits person status evidence",
  "verification_request_schema_url": "http://127.0.0.1:4242/metadata/schema/benefits_casework/person/schema.json"
}

401

Missing or invalid bearer credential.

application/problem+json

RFC 9457 Problem Details, returned for every non-2xx response.

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": "no credential provided in Authorization or x-api-key header",
  "request_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "status": 401,
  "title": "Missing credential",
  "type": "https://registry-relay.dev/problems/auth/missing_credential"
}

403

Authenticated principal lacks the scope required for this operation.

application/problem+json

RFC 9457 Problem Details, returned for every non-2xx response.

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": "no credential provided in Authorization or x-api-key header",
  "request_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "status": 401,
  "title": "Missing credential",
  "type": "https://registry-relay.dev/problems/auth/missing_credential"
}

default

Problem Details error response.

application/problem+json

RFC 9457 Problem Details, returned for every non-2xx response.

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": "no credential provided in Authorization or x-api-key header",
  "request_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "status": 401,
  "title": "Missing credential",
  "type": "https://registry-relay.dev/problems/auth/missing_credential"
}