Profiles

Organization Profiles are used to provide more context for an Issuer DID. Details about the issuer such as name and logo can be added using a Organization Profile. These details will be included in credentials that are issued by the DID.

Create Profile

The did and name fields are required to create a new Profile.

Create a Profile

POSThttps://api-testnet.dock.io/profiles

Body

application/json

Profile JSON object that will be applied to each issuer object when you create a credential that has an issuer DID profile

did*DID (string)

DID as fully qualified, typically. did:dock:

Example: "did:dock:xyz"

Response

200400402404

Profile has been created

Body

application/json

did*string

name*string

logostring

Request

JavaScriptCurlPython

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

Response

200400402404

{
  "did": "text",
  "name": "text",
  "logo": "text"
}

Get Profile

When a DID is provided in the path, the API will retrieve the Profile associated with that DID.

Info for a specific profile by DID

GEThttps://api-testnet.dock.io/profiles/{did}

Path parameters

did*DID (string)

DID as fully qualified, typically. did:dock:

Example: "did:dock:xyz"

Response

200400404

Expected response to a valid request

Body

application/json

did*string

name*string

logostring

Request

JavaScriptCurlPython

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

Response

200400404

{
  "did": "text",
  "name": "text",
  "logo": "text"
}

List Profiles

Return a list of all Profiles that your user account controls.

List all Profiles

GEThttps://api-testnet.dock.io/profiles

Query parameters

Response

200400

A paged array of profiles

Body

application/json

did*string

name*string

logostring

Request

JavaScriptCurlPython

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

Response

200400

[
  {
    "did": "text",
    "name": "text",
    "logo": "text"
  }
]

Update Profile

The update profile operation means that you can update the details of the profile. To do so, you need to provide a different value for at least one of name, description or logo.

Update a Profile

PATCHhttps://api-testnet.dock.io/profiles/{did}

Path parameters

did*DID (string)

DID as fully qualified, typically. did:dock:

Example: "did:dock:xyz"

Body

application/json

Profile JSON object that will be applied to each issuer object when you create a credential that has an issuer DID profile

did*DID (string)

DID as fully qualified, typically. did:dock:

Example: "did:dock:xyz"

Response

200400402

Profile has been updated

Body

application/json

did*string

name*string

logostring

Request

JavaScriptCurlPython

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

Response

200400402

{
  "did": "text",
  "name": "text",
  "logo": "text"
}

Delete Profile

Deletes a profile from our platform. It does NOT delete the associated DID, nor revoke the credentials issued for the profile.

Deletes a single profile based on the supplied value of DID

DELETEhttps://api-testnet.dock.io/profiles/{did}

Path parameters

did*DID (string)

DID as fully qualified, typically. did:dock:

Example: "did:dock:xyz"

Response

200400404

Profile Deleted

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.dock.io/profiles/{did}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400404

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