WebsiteTruvera Workspace

Data

List all notifications for your account

get
Authorizations
Query parameters
offsetinteger · int32Optional

How many items to offset by for pagination

Default: 0
limitinteger · int32 · min: 1 · max: 64Optional

How many items to return at one time (max 64)

Default: 64
readbooleanOptional

Whether to return read/unread items, or all if not provided

Responses
200
A paged array of notifications
application/json
get
GET /data/notifications HTTP/1.1
Host: api-testnet.dock.io
DOCK-API-TOKEN: YOUR_API_KEY
Accept: */*

{
  "total": 1,
  "list": [
    {
      "type": "text",
      "data": {},
      "created": "2025-06-30T22:13:58.235Z"
    }
  ]
}

Gets your user profile

get
Authorizations
Responses
200
Your user profile
application/json
get
GET /data/profile HTTP/1.1
Host: api-testnet.dock.io
DOCK-API-TOKEN: YOUR_API_KEY
Accept: */*

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

Updates your user profile metadata

patch
Authorizations
Body
namestringRequired
imagestringRequired
Responses
200
User profile has been updated
patch
PATCH /data/profile HTTP/1.1
Host: api-testnet.dock.io
DOCK-API-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 30

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

Marks all pending notifications as read

post
Authorizations
Responses
200
Latest notifications have been marked as read
post
POST /data/notifications/mark-read HTTP/1.1
Host: api-testnet.dock.io
DOCK-API-TOKEN: YOUR_API_KEY
Accept: */*

No content

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

post
Authorizations
Body
objectOptional
Responses
200
Success
application/json
Responseobject
post
POST /data/onboarding HTTP/1.1
Host: api-testnet.dock.io
CERTS-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{}
get

Gets the plan limits for your account

Authorizations
Responses
200
Account paid plan limits
application/json
get
GET /data/limits HTTP/1.1
Host: api-testnet.dock.io
DOCK-API-TOKEN: YOUR_API_KEY
Accept: */*

{
  "code": 1
}
get

Gets the call history for your account

Authorizations
Responses
200
Account paid calls history by date
application/json
Responseobject[]

Default response

get
GET /data/history HTTP/1.1
Host: api-testnet.dock.io
DOCK-API-TOKEN: YOUR_API_KEY
Accept: */*

[
  {}
]
get

Gets the transactions for your account

Authorizations
Query parameters
offsetinteger · int32Optional

How many items to offset by for pagination

Default: 0
limitinteger · int32 · min: 1 · max: 64Optional

How many items to return at one time (max 64)

Default: 64
Responses
200
Account transactions
application/json
get
GET /data/transactions HTTP/1.1
Host: api-testnet.dock.io
DOCK-API-TOKEN: YOUR_API_KEY
Accept: */*

{
  "total": 1,
  "list": [
    {}
  ]
}
get

Gets some statistics for your account

Authorizations
Responses
200
Account statistics
application/json
get
GET /data/stats HTTP/1.1
Host: api-testnet.dock.io
DOCK-API-TOKEN: YOUR_API_KEY
Accept: */*

{
  "code": 1
}
post

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

Authorizations
Body
validationstringOptional
Responses
200
Data has been deleted
application/json
post
POST /data/delete HTTP/1.1
Host: api-testnet.dock.io
DOCK-API-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "validation": "text"
}
{
  "code": 1
}
post

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

Authorizations
Body
reasonstringOptional
validationstringOptional
Responses
200
Account has been deleted
application/json
post
POST /data/accountdelete HTTP/1.1
Host: api-testnet.dock.io
DOCK-API-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "reason": "text",
  "validation": "text"
}
{
  "code": 1
}

PreviousIssuing paid credentials (KVAC algorithm integration)NextVerify

Last updated

Was this helpful?