WebsiteTruvera Workspace

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

post
/profiles
Authorizations
Body
didstring · min: 32Required

A DID

Example: did:cheqd:testnet:ac2b9027-ec1a-4ee2-aad1-1e316e7d6f59
Responses
200

Profile has been created

application/json
post
/profiles
POST /profiles HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "did": "did:cheqd:testnet:ac2b9027-ec1a-4ee2-aad1-1e316e7d6f59"
}
{
  "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

get
/profiles/{did}
Authorizations
Path parameters
didstring · min: 32Required

DID as fully qualified, typically. did:cheqd:

Example: did:cheqd:testnet:ac2b9027-ec1a-4ee2-aad1-1e316e7d6f59
Responses
200

Expected response to a valid request

application/json
get
/profiles/{did}
GET /profiles/{did} HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

List profiles

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

List all Profiles

get
/profiles
Authorizations
Query parameters
offsetinteger · int32Optional

How many items to offset by for pagination

Default: 0
limitinteger · int32 · min: 1 · max: 64Optional

How many items to return at one time (max 64)

Default: 64
Responses
200

A paged array of profiles

application/json
get
/profiles
GET /profiles HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

patch
/profiles/{did}
Authorizations
Path parameters
didstring · min: 32Required

DID as fully qualified, typically. did:cheqd:

Example: did:cheqd:testnet:ac2b9027-ec1a-4ee2-aad1-1e316e7d6f59
Body
didstring · min: 32Required

A DID

Example: did:cheqd:testnet:ac2b9027-ec1a-4ee2-aad1-1e316e7d6f59
Responses
200

Profile has been updated

application/json
patch
/profiles/{did}
PATCH /profiles/{did} HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "did": "did:cheqd:testnet:ac2b9027-ec1a-4ee2-aad1-1e316e7d6f59"
}
{
  "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

delete
/profiles/{did}
Authorizations
Path parameters
didstring · min: 32Required

DID as fully qualified, typically. did:cheqd:

Example: did:cheqd:testnet:ac2b9027-ec1a-4ee2-aad1-1e316e7d6f59
Responses
200

Profile Deleted

No content
delete
/profiles/{did}
DELETE /profiles/{did} HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
PreviousDIDsNextCredentials

Last updated

Was this helpful?