curl --request DELETE \
--url "https://directory.example.com/dids/did%3Aopenpayload%3A1111111111111111111111/document/services/did%3Aopenpayload%3A1111111111111111111111%23messages" \
--header "Content-Type: application/json" \
--data '{
"did": "did:openpayload:1111111111111111111111",
"action": "RemoveService",
"id": "did:openpayload:1111111111111111111111#messages",
"nonce": "<nonce>",
"valid_until": "<future-epoch-milliseconds>",
"signer_key_id": "root",
"canonical_payload": "<payload>",
"signature": "<signature>"
}'
{
"status": "accepted",
"did": "did:openpayload:1111111111111111111111",
"action": "RemoveService",
"tx_hash": "<transaction-hash>",
"message": "DID document modification submitted"
}
DID documents
Remove a DID service
Remove a DID service in a public OpenPayload DID document.
curl --request DELETE \
--url "https://directory.example.com/dids/did%3Aopenpayload%3A1111111111111111111111/document/services/did%3Aopenpayload%3A1111111111111111111111%23messages" \
--header "Content-Type: application/json" \
--data '{
"did": "did:openpayload:1111111111111111111111",
"action": "RemoveService",
"id": "did:openpayload:1111111111111111111111#messages",
"nonce": "<nonce>",
"valid_until": "<future-epoch-milliseconds>",
"signer_key_id": "root",
"canonical_payload": "<payload>",
"signature": "<signature>"
}'
{
"status": "accepted",
"did": "did:openpayload:1111111111111111111111",
"action": "RemoveService",
"tx_hash": "<transaction-hash>",
"message": "DID document modification submitted"
}
Remove a DID service in a public OpenPayload DID document.
Removing a service tells compatible clients to stop discovering that endpoint through this DID. It does not contact, shut down, or delete data from the referenced server.
Read Authorize a Directory update before signing.
Path parameters
string
required
The DID to update.
string
required
The service ID.
Request body
string
required
The DID to update. It must match the path.
string
required
The operation name. Use
RemoveService.string
required
The public id value for this operation.
string
required
The request nonce.
string
required
The authorization expiration time.
string
The public signing-key identifier. Defaults to
root.string
required
The payload supplied by an OpenPayload-compatible signer.
string
required
The authorization signature.
curl --request DELETE \
--url "https://directory.example.com/dids/did%3Aopenpayload%3A1111111111111111111111/document/services/did%3Aopenpayload%3A1111111111111111111111%23messages" \
--header "Content-Type: application/json" \
--data '{
"did": "did:openpayload:1111111111111111111111",
"action": "RemoveService",
"id": "did:openpayload:1111111111111111111111#messages",
"nonce": "<nonce>",
"valid_until": "<future-epoch-milliseconds>",
"signer_key_id": "root",
"canonical_payload": "<payload>",
"signature": "<signature>"
}'
Response
string
required
The submission status.
string
required
The affected DID.
string
required
The document operation.
string
required
The transaction hash.
string
required
A human-readable submission result.
{
"status": "accepted",
"did": "did:openpayload:1111111111111111111111",
"action": "RemoveService",
"tx_hash": "<transaction-hash>",
"message": "DID document modification submitted"
}
202 Accepted means the Directory accepted the request for processing. It does not confirm final settlement.Straight to the point
- Action:
RemoveService - Signed item: service
id - Does not modify the external service itself