Links
👉

Set up your account

Learn how to set up your account on Credential Service.
The user is required to Log In to the Credential Service and authenticate in order to access the APIs. This guards the API from unauthorized access and is required for both testing production environments.

Step 1: Click Log In on Credential Service Swagger

Head to our Credential Service and click Log In to get started.
Credential Service uses a third party service called LogTo to handle user authentication and login. This allows users to create new accounts as well as sign in using their email, Google single sign-on, or Discord login.
Sign into your account
Create a new account

Step 2: Locate your cheqd address (for CHEQ)

The following API can be used to fetch the new account information:
  • customer_id is used as an identifier for the particular customer using the Credential Service. It is generated as a sub-field of the JWT token used in the authorization header.
  • cheqd_account is used to pay for identity transactions on either testnet or mainnet. A cheqd account is automatically generated when a new customer_id is generated.
get
/account
Fetch custodian-mode client details.

This endpoint returns the custodian-mode client details for authenticated users.

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.

(Optional) Step 3: Adding CHEQ tokens to your account

Users will need to add our token, CHEQ, to their cheqd_account on mainnet in order to be able to use the ledger-based identity functionality on Credential Service, such as creating DIDs and DID-Linked Resources.
If you need to add CHEQ tokens to your Credential Service cheqd_account, there are a few steps you need to follow:
Mainnet
Testnet
  • It is unlikely that you will ever need to top up your Testnet account, as this is handled automatically. However, in the event that your Testnet account runs out of tokens, you can follow the step below.
  • This is super simple. You can add free CHEQ tokens to your cheqd_account via our Testnet Faucet by inputting your cheqd account address. Access the Testnet Faucet directly here.
Once you have successfully created an account and have topped up your CHEQ tokens, you are ready to get started!
Last modified 5mo ago