Inviting participants

Invites a Trust Registry participant

POSThttps://api-testnet.dock.io/trust-registries/{registryId}/participants

Path parameters

registryId*string

A trust registry id

registryId*string

A Trust Registry ID

Body

application/json

Trust Registry participant metadata

maxAgeinteger

Max age of the invite in seconds

issuerSchemasarray of string

verifierSchemasarray of string

Response

200400401402

Trust Registry participant has been invited

Body

application/json

link*string

The trust registry invite link

Example: "https://trust-registry.dock.io/ecosystems?token=eyJhbGc...2VVqUw"

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.dock.io/trust-registries/{registryId}/participants', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401402

{
  "link": "https://trust-registry.dock.io/ecosystems?token=eyJhbGc...2VVqUw"
}

Get Trust Registry participants

Returns the Trust Registry participants

GEThttps://api-testnet.dock.io/trust-registries/{registryId}/participants

Path parameters

registryId*string

A trust registry id

Query parameters

Response

200400401404

List of participants

Body

application/json

total*integer

Total number of participants

Example: 42

list*array of TrustRegistryParticipant (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.dock.io/trust-registries/{registryId}/participants', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401404

{
  "total": 42,
  "list": [
    {
      "id": "23314808-eec6-4492-9a8a-8f32e34b8155",
      "name": "Dock Issuer",
      "did": "did:dock:xyz",
      "description": "Labore voluptate adipisicing magna duis eu fugiat pariatur excepteur irure.",
      "logoUrl": "https://logo.dock.io/participant",
      "infoUrl": "https://info.dock.io/trust-registry/participant/1234",
      "status": "active",
      "role": "issuer",
      "created": "2024-11-21T07:42:33.752Z",
      "suspendedAt": "text",
      "issuerSchemas": [
        "https://schema.dock.io/ExampleSchema-V5-1722512884923.json"
      ],
      "verifierSchemas": [
        "https://schema.dock.io/ExampleSchema-V5-1722512884923.json"
      ]
    }
  ]
}

Update a Trust Registry participant

PATCHhttps://api-testnet.dock.io/trust-registries/{registryId}/participants/{participantId}

Path parameters

registryId*string

A trust registry id

participantId*string

A participant id

registryId*string

A Trust Registry ID

Body

application/json

Trust Registry participant metadata to be updated

namestring

Trust registry participant name

Example: "Dock Issuer"

logoUrlstring (uri)

Trust registry participant logo URL

Example: "https://logo.dock.io/trust-registry-participant/1234"

infoUrlany of

Example: "https://info.dock.io/trust-registry/participant/1234"

string (uri)enum

statusenum

Trust registry participant status

Example: "active"

activesuspended

suspendedAtstring

issuerSchemasarray of string

verifierSchemasarray of string

Response

200400401402

Trust Registry participant has been updated

Body

application/json

id*string

Trust registry participant ID

Example: "23314808-eec6-4492-9a8a-8f32e34b8155"

name*string

Trust registry participant name

Example: "Dock Issuer"

did*DID (string)

DID as fully qualified, typically. did:dock:

Example: "did:dock:xyz"

descriptionstring

Trust registry participant description

Example: "Labore voluptate adipisicing magna duis eu fugiat pariatur excepteur irure."

logoUrl*string (uri)

Trust registry participant logo URL

Example: "https://logo.dock.io/participant"

infoUrlany of

Example: "https://info.dock.io/trust-registry/participant/1234"

string (uri)enum

statusenum

Trust registry participant status

Example: "active"

activesuspended

roleenum

Trust registry participant role

Example: "issuer"

verifier+issuerissuerverifier

createdstring (date-time)

suspendedAtstring

issuerSchemasarray of string

verifierSchemasarray of string

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.dock.io/trust-registries/{registryId}/participants/{participantId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401402

{
  "id": "23314808-eec6-4492-9a8a-8f32e34b8155",
  "name": "Dock Issuer",
  "did": "did:dock:xyz",
  "description": "Labore voluptate adipisicing magna duis eu fugiat pariatur excepteur irure.",
  "logoUrl": "https://logo.dock.io/participant",
  "infoUrl": "https://info.dock.io/trust-registry/participant/1234",
  "status": "active",
  "role": "issuer",
  "created": "2024-11-21T07:42:33.752Z",
  "suspendedAt": "text",
  "issuerSchemas": [
    "https://schema.dock.io/ExampleSchema-V5-1722512884923.json"
  ],
  "verifierSchemas": [
    "https://schema.dock.io/ExampleSchema-V5-1722512884923.json"
  ]
}

Accepts an invite to an ecosystem

POSThttps://api-testnet.dock.io/trust-registries/invitations/accept

Body

application/json

Trust Registry participant invite code

token*string

The invite token

Example: "eyJhbGc...2VVqUw"

did*DID (string)

DID as fully qualified, typically. did:dock:

Example: "did:dock:xyz"

infoUrl*any of

Example: "https://info.dock.io/trust-registry/participant/1234"

string (uri)enum

Response

200400401402

Invite was accepted

Body

application/json

id*string

Trust registry participant ID

Example: "23314808-eec6-4492-9a8a-8f32e34b8155"

name*string

Trust registry participant name

Example: "Dock Issuer"

did*DID (string)

DID as fully qualified, typically. did:dock:

Example: "did:dock:xyz"

descriptionstring

Trust registry participant description

Example: "Labore voluptate adipisicing magna duis eu fugiat pariatur excepteur irure."

logoUrl*string (uri)

Trust registry participant logo URL

Example: "https://logo.dock.io/participant"

infoUrlany of

Example: "https://info.dock.io/trust-registry/participant/1234"

string (uri)enum

statusenum

Trust registry participant status

Example: "active"

activesuspended

roleenum

Trust registry participant role

Example: "issuer"

verifier+issuerissuerverifier

createdstring (date-time)

suspendedAtstring

issuerSchemasarray of string

verifierSchemasarray of string

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.dock.io/trust-registries/invitations/accept', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "token": "eyJhbGc...2VVqUw",
      "did": "did:dock:xyz",
      "infoUrl": "https://info.dock.io/trust-registry/participant/1234"
    }),
});
const data = await response.json();

Response

200400401402

{
  "id": "23314808-eec6-4492-9a8a-8f32e34b8155",
  "name": "Dock Issuer",
  "did": "did:dock:xyz",
  "description": "Labore voluptate adipisicing magna duis eu fugiat pariatur excepteur irure.",
  "logoUrl": "https://logo.dock.io/participant",
  "infoUrl": "https://info.dock.io/trust-registry/participant/1234",
  "status": "active",
  "role": "issuer",
  "created": "2024-11-21T07:42:33.752Z",
  "suspendedAt": "text",
  "issuerSchemas": [
    "https://schema.dock.io/ExampleSchema-V5-1722512884923.json"
  ],
  "verifierSchemas": [
    "https://schema.dock.io/ExampleSchema-V5-1722512884923.json"
  ]
}

Decline the invitation of joining a trust registry

POSThttps://api-testnet.dock.io/trust-registries/invitations/decline

Body

application/json

Trust Registry participant invite token

token*string

Trust Registry participant invite token

Example: "eyJhbG...2VVqUw"

maxAgeinteger

Token max age in seconds

Example: 604800

Response

200400401402

Invitation has been declined

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.dock.io/trust-registries/invitations/decline', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "token": "eyJhbG...2VVqUw"
    }),
});
const data = await response.json();

Response

400401402

{
  "type": "text",
  "message": "text"
}

Snooze the invitation of joining a trust registry

POSThttps://api-testnet.dock.io/trust-registries/invitations/snooze

Body

application/json

Trust Registry participant invite code

token*string

Trust Registry participant invite token

Example: "eyJhbG...2VVqUw"

maxAgeinteger

Token max age in seconds

Example: 604800

Response

200400401402

Invitation has been declined

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.dock.io/trust-registries/invitations/snooze', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "token": "eyJhbG...2VVqUw"
    }),
});
const data = await response.json();

Response

400401402

{
  "type": "text",
  "message": "text"
}

Remove Trust Registry participant

Removes a Trust Registry participant

DELETEhttps://api-testnet.dock.io/trust-registries/{registryId}/participants/{participantId}

Path parameters

registryId*string

A trust registry id

participantId*string

A participant id

Response

200400401404500

Trust Registry participant has been deleted

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.dock.io/trust-registries/{registryId}/participants/{participantId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401404500

{
  "type": "text",
  "message": "text"
}