Data

List all notifications for your account

GEThttps://api-testnet.dock.io/data/notifications

Query parameters

Response

200400

A paged array of notifications

Body

application/json

total*integer

The total number of records

list*array of Notification (object)

The current paged records

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.dock.io/data/notifications', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "total": 0,
  "list": [
    {
      "type": "text",
      "created": "2025-01-09T19:57:30.019Z"
    }
  ]
}

Gets your user profile

GEThttps://api-testnet.dock.io/data/profile

Response

200400

Your user profile

Body

application/json

name*string

image*string

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.dock.io/data/profile', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "name": "text",
  "image": "text"
}

Updates your user profile metadata

PATCHhttps://api-testnet.dock.io/data/profile

Body

application/json

User profile metadata

name*string

image*string

Response

200400

User profile has been updated

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.dock.io/data/profile', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "image": "text",
      "name": "text"
    }),
});
const data = await response.json();

Response

400

{
  "status": 0,
  "type": "text",
  "message": "text"
}

Marks all pending notifications as read

POSThttps://api-testnet.dock.io/data/notifications/mark-read

Response

200400

Latest notifications have been marked as read

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.dock.io/data/notifications/mark-read', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

400

{
  "status": 0,
  "type": "text",
  "message": "text"
}

Certs internal route, not for typical usage. Submits onboarding information for new accounts.

POSThttps://api-testnet.dock.io/data/onboarding

Authorization

nextAuth

Body

application/json

User profile metadata

object

Response

200400

Success

Body

application/json

object

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.dock.io/data/onboarding', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

400

{
  "status": 0,
  "type": "text",
  "message": "text"
}

Gets the plan limits for your account

GEThttps://api-testnet.dock.io/data/limits

Response

200400

Account paid plan limits

Body

application/json

codeinteger

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.dock.io/data/limits', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "code": 0
}

Gets the call history for your account

GEThttps://api-testnet.dock.io/data/history

Response

200400

Account paid calls history by date

Body

application/json

ArrayResponse (array of object)

Default response

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.dock.io/data/history', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

[]

Gets the transactions for your account

GEThttps://api-testnet.dock.io/data/transactions

Query parameters

Response

200400

Account transactions

Body

application/json

total*integer

list*array of object

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.dock.io/data/transactions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "total": 0,
  "list": []
}

Gets some statistics for your account

GEThttps://api-testnet.dock.io/data/stats

Response

200400

Account statistics

Body

application/json

codeinteger

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.dock.io/data/stats', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "code": 0
}

Deletes all data stored on our servers (credentials, dids, profiles, etc - not authentication/account data).

POSThttps://api-testnet.dock.io/data/delete

Body

application/json

Enter the account email as validation for deletion

validationstring

Response

200400401

Data has been deleted

Body

application/json

codeinteger

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.dock.io/data/delete', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401

{
  "code": 0
}

WARNING - Deletes your entire account! this is a two step process that requires getting a token then re-submitting that token as validation

POSThttps://api-testnet.dock.io/data/accountdelete

Body

application/json

Enter the token as validation for deletion

reasonstring

validationstring

Response

200400401

Account has been deleted

Body

application/json

codeinteger

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.dock.io/data/accountdelete', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401

{
  "code": 0
}