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

Trust Registry participant metadata

maxAgeinteger

Max age of the invite in seconds

issuerSchemasarray of string

verifierSchemasarray of string

Response

Trust Registry participant has been invited

Body

link*string

The trust registry invite link

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

Request

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

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

Get Trust Registry participant

Returns the Trust Registry participant

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

Path parameters

registryId*string

A trust registry id

participantId*string

A participant id

Response

Participant information

Body

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"

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

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

Response

{
  "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-09-16T19:04:29.617Z",
  "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

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"

statusenum

Trust registry participant status

Example: "active"

activesuspended

suspendedAtstring

issuerSchemasarray of string

verifierSchemasarray of string

Response

Trust Registry participant has been updated

Body

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"

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

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

{
  "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-09-16T19:04:29.617Z",
  "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

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"

Response

Invite was accepted

Body

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"

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

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

{
  "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-09-16T19:04:29.617Z",
  "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

Trust Registry participant invite token

token*string

Trust Registry participant invite token

Example: "eyJhbG...2VVqUw"

maxAgeinteger

Token max age in seconds

Example: 604800

Response

Invitation has been declined

Request

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

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

Snooze the invitation of joining a trust registry

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

Body

Trust Registry participant invite code

token*string

Trust Registry participant invite token

Example: "eyJhbG...2VVqUw"

maxAgeinteger

Token max age in seconds

Example: 604800

Response

Invitation has been declined

Request

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

{
  "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

Trust Registry participant has been deleted

Request

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

Response

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

PreviousCreating a Trust Registry NextTrust Registry Schemas

Last updated 25 days ago

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();

{ "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-09-16T19:04:29.617Z", "suspendedAt": "text", "issuerSchemas": [ "https://schema.dock.io/ExampleSchema-V5-1722512884923.json" ], "verifierSchemas": [ "https://schema.dock.io/ExampleSchema-V5-1722512884923.json" ] }

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();