Account

Fetch custodian-mode client details.

get

https://studio-api.cheqd.nethttps://studio-api-staging.cheqd.nethttp://localhost:3000

/account

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

Authorizations

ApiKeyAuth

x-api-keystringRequired

Responses

200

The request was successful.

application/json

400

A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.

401

Access token is missing or invalid

500

An internal error has occurred. Additional state information plus metadata may be available in the response body.

get

/account

HTTPcURLJavaScriptPython

GET /account HTTP/1.1
Host: studio-api.cheqd.net
x-api-key: YOUR_API_KEY
Accept: */*

{
  "customer": {
    "customerId": "text",
    "name": "text"
  },
  "paymentAccount": {
    "mainnet": "text",
    "testnet": "text"
  }
}

Deprecated

Fetch IdToken.

get

https://studio-api.cheqd.nethttps://studio-api-staging.cheqd.nethttp://localhost:3000

/account/idtoken

This endpoint returns IdToken as JWT with list of user roles inside

Authorizations

ApiKeyAuth

x-api-keystringRequired

Responses

200

The request was successful.

application/json

400

A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.

401

Access token is missing or invalid

500

An internal error has occurred. Additional state information plus metadata may be available in the response body.

get

/account/idtoken

HTTPcURLJavaScriptPython

GET /account/idtoken HTTP/1.1
Host: studio-api.cheqd.net
x-api-key: YOUR_API_KEY
Accept: */*

{
  "idToken": "text"
}

Create an client for an authenticated user.

post

https://studio-api.cheqd.nethttps://studio-api-staging.cheqd.nethttp://localhost:3000

/account/create

This endpoint creates a client in the custodian-mode for an authenticated user

Authorizations

ApiKeyAuth

x-api-keystringRequired

Body

application/x-www-form-urlencodedapplication/json

namestringOptional

primaryEmailstringRequired

Responses

201

The request was successful.

application/json

400

A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.

401

Access token is missing or invalid

500

An internal error has occurred. Additional state information plus metadata may be available in the response body.

post

/account/create

HTTPcURLJavaScriptPython

POST /account/create HTTP/1.1
Host: studio-api.cheqd.net
x-api-key: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 37

"name='text'&primaryEmail='text'"

application/x-www-form-urlencodedapplication/json

{
  "customerId": "text",
  "name": "text",
  "email": "text",
  "description": "text",
  "createdAt": "text",
  "updatedAt": "text",
  "paymentProviderId": "text"
}

Fetch Account Analytics.

get

https://studio-api.cheqd.nethttps://studio-api-staging.cheqd.nethttp://localhost:3000

/account/analytics

This endpoint returns analytics data for the account usage.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Query parameters

networkstring · enumOptional

Filter DID by the network published.

Possible values:

Responses

200

The request was successful.

application/json

400

A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.

401

Access token is missing or invalid

500

An internal error has occurred. Additional state information plus metadata may be available in the response body.

get

/account/analytics

HTTPcURLJavaScriptPython

GET /account/analytics HTTP/1.1
Host: studio-api.cheqd.net
x-api-key: YOUR_API_KEY
Accept: */*

{
  "dids": 1,
  "credentials": 1,
  "accreditations": 1,
  "resources": 1
}