Links

Create Identity Keys and Subject DIDs

Issuers may want to create identity keypairs for multiple reasons, such as for signing payloads or for creating did:key DIDs.
post
/key/create
Create an identity key pair.

This endpoint creates an identity key pair associated with the user's account for custodian-mode clients.

Parameters
No parameters
Responses
200: OK
The request was successful.
400: Bad Request
A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.
401: Unauthorized
Access token is missing or invalid
500: Internal Server Error
An internal error has occurred. Additional state information plus metadata may be available in the response body.
There is also an option to fetch an identity keypair by inputting a Key ID (kid) as a request format.
get
/key/read/{kid}
Fetch an identity key pair.

This endpoint fetches an identity key pair's details for a given key ID. Only the user account associated with the custodian-mode client can fetch the key pair.

Parameters
Path
kid*
string
Key ID of the identity key pair to fetch.
Responses
200: OK
The request was successful.
400: Bad Request
A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.
401: Unauthorized
Access token is missing or invalid
500: Internal Server Error
An internal error has occurred. Additional state information plus metadata may be available in the response body.

Creating a Subject DID

Credential Service currently supports two types of subject DIDs:
  • did:key
  • did:vda
With the former, you can follow the did:key specification to create a subject DID based on a generated keypair.
With the latter, you can setup your did:vda subject DID on your Verida wallet. Using the Credential Service, you will be able to send credentials to your Verida wallet and use it to store and securely back them up.