API docs by Redocly

TRQP Restful Binding (1.0.0)

Download OpenAPI specification:Download

This specification defines a RESTful TRQP Binding. It includes endpoints for retrieving Trust Registry metadata, authorization data, verifying entity authorization status, and checking ecosystem recognition.

trqp-core

TRQP Compliant Queries

Queries registry for recognition, by and ecosystem, of another ecosystem.

Request Body schema: application/json
entity_id
required
string

Unique identifier of the TRUST REGISTRY (identified by DID) that is the subject of the query. This is the "other trust registry" in the "Does your ecosystem recognized this other trust registry as assertion_id?".

authority_id
required
string

Unique identifier of the ECOSYSTEM (identified by DID) that is being queried. This is the "your ecosystem" in the "Does your ecosystem recognize this other trust registry as assertion_id?".

assertion_id
required
string

The assertion_id that is being tested against. This is the assertion_id in the "Does your ecosystem recognize this other trust registry as assertion_id?".

object

A flexible context object that can hold arbitrary key-value pairs.

  • NOTE: time is codified as it is a standard context to be considered.

Responses

Request samples

Content type
application/json
{
  • "entity_id": "string",
  • "authority_id": "string",
  • "assertion_id": "string",
  • "context": {
    }
}

Response samples

Content type
application/json
{
  • "entity_id": "string",
  • "authority_id": "string",
  • "assertion_id": "string",
  • "recognized": true,
  • "time_requested": "2019-08-24T14:15:22Z",
  • "time_evaluated": "2019-08-24T14:15:22Z",
  • "message": "string",
  • "context": {
    }
}

Queries registry for recognition, by and ecosystem, of another ecosystem.

Request Body schema: application/json
entity_id
required
string

Unique identifier of the TRUST REGISTRY (identified by DID) that is the subject of the query. This is the 'EntityX` in the "Does EntityX have AuthorityY in EcosystemZ?".

authority_id
required
string

Unique identifier of the ECOSYSTEM (identified by DID) that is being queried. This is the "EcosystemZ" in the "Does EntityX have AuthorityY in EcosystemZ?".

assertion_id
required
string

The assertion_id that is being tested against. This is the AuthorityY in the "Does EntityX have AuthorityY in EcosystemZ?".

object

A flexible context object that can hold arbitrary key-value pairs.

  • NOTE: time is codified as it is a standard context to be considered.

Responses

Request samples

Content type
application/json
{
  • "entity_id": "string",
  • "authority_id": "string",
  • "assertion_id": "string",
  • "context": {
    }
}

Response samples

Content type
application/json
{
  • "entity_id": "string",
  • "authority_id": "string",
  • "assertion_id": "string",
  • "assertion_verified": true,
  • "time_requested": "2019-08-24T14:15:22Z",
  • "time_evaluated": "2019-08-24T14:15:22Z",
  • "message": "string",
  • "context": {
    }
}