Default
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
nullOptional
public_keyany ofOptional
stringOptional
nullOptional
key_typeany ofOptional
stringOptional
nullOptional
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
get
GET /did/list HTTP/1.1
Host:
Accept: */*
No content
Create a new DID and return PSBT
Body
spend_addrstringRequired
verification_capabilitiesintegerRequired
control_addressstringRequired
subject_public_keystringRequired
key_typestringRequired
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
post
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
Update DID and return PSBTs
Body
spend_addrstringRequired
control_addressstringRequired
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
post
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
Deactivate DID and return PSBT
Body
spend_addrstringRequired
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
post
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 query DID documents by DID list (limit: max 100)
Body
didsstring[]Required
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
post
POST /did/batch_get HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 17
{
"dids": [
"text"
]
}
No content
Verify DID signature
Query parameters
didstringRequired
signaturestringRequired
datastringRequired
sign_typeany ofOptionalDefault:
Signature type: standard, unisat, bitcoin_message
standard
stringOptional
nullOptional
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
post
POST /did/verify?did=text&signature=text&data=text HTTP/1.1
Host:
Accept: */*
No content