Profiles
Last updated
Last updated
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.
POST /profiles GET /profiles/{did} GET /profiles PATCH /profiles/{did} DELETE /profiles/{did}
The did
and name
fields are required to create a new Profile.
Name | In | Type | Required | Description |
---|---|---|---|---|
Status | Meaning | Description | Schema |
---|---|---|---|
When a DID is provided in the path, the API will retrieve the Profile associated with that DID.
Return a list of all Profiles that your user account controls.
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
.
Deletes a profile from our platform. It does NOT delete the associated DID, nor revoke the credentials issued for the profile.
Name | In | Type | Required | Description |
---|---|---|---|---|
Status | Meaning | Description | Schema |
---|---|---|---|
Name | In | Type | Required | Description |
---|---|---|---|---|
Status | Meaning | Description | Schema |
---|---|---|---|
Name | In | Type | Required | Description |
---|---|---|---|---|
Status | Meaning | Description | Schema |
---|---|---|---|
Name | In | Type | Required | Description |
---|---|---|---|---|
Status | Meaning | Description | Schema |
---|---|---|---|
did
body
true
DID as fully qualified, e.g., did:dock:
.
name
body
string
true
The name to use for this issuer (e.g. a school name).
description
body
string
false
A description of the issuer.
logo
body
string
false
A Base64 encoded image to use as the logo for the issuer.
200
The request was successful and the Profile was created.
400
The request was unsuccessful, because of invalid params.
did
path
true
Represents a specific DID that uniquely identifies the profile.
200
The request was successful and will return the profile.
404
The requested profile was not found.
offset
query
integer
false
How many items to offset by for pagination
limit
query
integer
false
How many items to return at one time (max 64)
200
All of a user's profiles.
did
body
true
DID as fully qualified, e.g., did:dock:
.
name
body
string
true
The name to use for this issuer (e.g. a school name).
description
body
string
false
A description of the issuer.
logo
body
string
false
A Base64 encoded image to use as the logo for the issuer.
200
The request was successful and will update the profile.
400
The controller value is incorrect.
401
The request was unsuccessful, because you don't own the profile.
404
The profile does not exist.
did
path
true
Represents a specific DID that uniquely identifies the profile to delete.
200
The request was successful and will remove the profile.
401
The request was unsuccessful because you don't own the profile.
404
The profile does not exist.
405
The {did} value is blank/empty. Please ensure that the {did} value does exist.