Resolver API
Resolving a DID
Make a GET request to resolve a DID:
GET /1.0/identifiers/{did}
Example
curl --location '{base url}/1.0/identifiers/did:bsv:b5c8407a46b32c4a59b3fe0693860588b00a0e7464d252cc6ac47089925c1e8c'
Response Format
The service returns a DID Resolution Result in JSON, which includes:
didDocument
– The resolved DID Document (ornull
if not applicable)didDocumentMetadata
– Metadata about the DID Document (e.g., deactivation status, update times)didResolutionMetadata
– Metadata about the resolution process (e.g., errors, method used)
API Responses and Error codes
The resolver returns different HTTP status codes and response bodies based on the DID state:
Active DID
200 OK
Returns complete Document, Resolution Metadata, and Document Metadata
Deactivated DID
410 GONE
Document is null, metadata indicates deactivation
Invalid DID URL
400 BAD REQUEST
Resolution metadata contains invalidDidUrl
error
Invalid DID
400 BAD REQUEST
Resolution metadata contains invalidDid
error
DID Not Found
404 NOT FOUND
Resolution metadata contains notFound
error
Method Not Supported
501 NOT IMPLEMENTED
Resolution metadata contains methodNotSupported
error
Invalid DID Data
502 BAD GATEWAY
Resolution metadata contains invalidDidData
error
Service Unavailable
503 SERVICE UNAVAILABLE
Resolution metadata contains serviceUnavailable
error
Internal Error
500 INTERNAL SERVER ERROR
Resolution metadata contains internalError
error
Example Successful Response (Active DID)
{
"didDocument": { /* W3C-compliant DID Document */ },
"didResolutionMetadata": {
"contentType": {
"mimeType": "application/ld+json",
"charset": null
}
},
"didDocumentMetadata": {
"versionId": "96b77a29afa6155a6c8911d96fe20c3dc3c921762c2b9a864c73a258dff4fcd8",
"method": {
"transaction_id": "96b77a29afa6155a6c8911d96fe20c3dc3c921762c2b9a864c73a258dff4fcd8",
"transaction_raw": " /* transaction in the raw hex format */",
"block": {
"blocktime": 1553501874,
"confirmations": 322574,
"hash": "testBlockHash",
"blockheight": 575191
}
},
"equivalentID": [],
"created": "2025-08-12T14:21:12.232Z"
}
}
Example Error Response (DID Not Found)
{
"didDocument": null,
"didResolutionMetadata": {
"error": "notFound"
},
"didDocumentMetadata": {}
}
Last updated