Default

Health Check

get

Health check endpoint

Responses

200

Successful Response

application/json

Responseany

get

/health

HTTPcURLJavaScriptPython

GET /health HTTP/1.1
Host: 
Accept: */*

200

Successful Response

No content

Api Resolve

get

Resolve DID document

Query parameters

didstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/did/resolve

HTTPcURLJavaScriptPython

GET /did/resolve?did=text HTTP/1.1
Host: 
Accept: */*

No content

Api List Dids

get

List DIDs with optional filtering by controller or public_key_multibase, and pagination

Query parameters

pageinteger · min: 1OptionalDefault: 1

page_sizeinteger · min: 1 · max: 100OptionalDefault: 20

controllerany ofOptional

stringOptional

or

nullOptional

public_keyany ofOptional

stringOptional

or

nullOptional

key_typeany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/did/list

HTTPcURLJavaScriptPython

GET /did/list HTTP/1.1
Host: 
Accept: */*

No content

Did History

get

Get the complete history of DID operations

Query parameters

didstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/did/history

HTTPcURLJavaScriptPython

GET /did/history?did=text HTTP/1.1
Host: 
Accept: */*

No content

Did At Height

get

Get DID document state at specific block height

Query parameters

didstringRequired

heightintegerRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/did/at_height

HTTPcURLJavaScriptPython

GET /did/at_height?did=text&height=1 HTTP/1.1
Host: 
Accept: */*

No content

Api Create

post

Create a new DID and return PSBT

Body

application/json

spend_addrstringRequired

verification_capabilitiesintegerRequired

control_addressstringRequired

subject_public_keystringRequired

key_typestringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/did/create

HTTPcURLJavaScriptPython

POST /did/create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 122

{
  "spend_addr": "text",
  "verification_capabilities": 1,
  "control_address": "text",
  "subject_public_key": "text",
  "key_type": "text"
}

No content

Api Update

post

Update DID and return PSBTs

Body

application/json

spend_addrstringRequired

control_addressstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/did/update

HTTPcURLJavaScriptPython

POST /did/update HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 155

{
  "original_utxo": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "spend_addr": "text",
  "vm_updates": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "control_address": "text"
}

No content

Api Deactivate

post

Deactivate DID and return PSBT

Body

application/json

spend_addrstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/did/deactivate

HTTPcURLJavaScriptPython

POST /did/deactivate HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "original_utxo": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "spend_addr": "text"
}

No content

Batch Get Dids

post

Batch query DID documents by DID list (limit: max 100)

Body

application/json

didsstring[]Required

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/did/batch_get

HTTPcURLJavaScriptPython

POST /did/batch_get HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "dids": [
    "text"
  ]
}

No content

Did Verify

post

Verify DID signature

Query parameters

didstringRequired

signaturestringRequired

datastringRequired

sign_typeany ofOptional

Signature type: standard, unisat, bitcoin_message

Default: standard

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/did/verify

HTTPcURLJavaScriptPython

POST /did/verify?did=text&signature=text&data=text HTTP/1.1
Host: 
Accept: */*

No content