VDX - DIF Universal Registrar (0.1)
Download OpenAPI specification:Download
VDX - DIF Compatible Universal Registrar for DIDs
Creates a DID.
Creates a Decentralized Id i.e. DID returns the object.
query Parameters
| method required | string Example: method=key The requested DID method for the operation. |
Request Body schema: application/json
| jobId | string Id of an ongoing DID creation process. |
object Options for the DID create operation, such as the network where the DID should be created | |
| secret | object Object with DID controller keys and other secrets needed for performing the DID create operation. |
| didDocument | object Partial or complete DID document |
Responses
Request samples
- Payload
{- "jobId": "6d85bcd0-2ea3-4288-ab00-15afadd8a156",
- "options": {
- "chain": "testnet"
}, - "secret": {
- "seed": "72WGp7NgFR1Oqdi8zlt7jQQ434XR0cNQ"
}, - "didDocument": { }
}Response samples
- 200
- 201
- 400
- 500
{- "jobId": "6d85bcd0-2ea3-4288-ab00-15afadd8a156",
- "didState": {
- "state": "finished",
- "did": "did:didMethod1:WRfXPg8dantKVubE3HX8pw",
- "secret": {
- "keys": [
- {
- "privateKeyJwk": {
- "kty": "OKP",
- "d": "NzJXR3A3TmdGUjFPcWRpOHpsdDdqUVE0MzRYUjBjTlE",
- "crv": "Ed25519",
- "x": "jpIKKU2b77lNXKTNW2NGvw1GUMjU6v_l_tLJAH5uYz0"
}, - "publicKeyDIDURL": "did:didMethod1:WRfXPg8dantKVubE3HX8pw#key-1"
}
]
}
}, - "didRegistrationMetadata": { },
- "didDocumentMetadata": { }
}Update a DID.
Updates a Decentralized Id
query Parameters
| method required | string Example: method=didMethod1 The requested DID method for the operation. |
Request Body schema: application/json
| jobId | string Id of an ongoing DID creation process. |
| did required | string DID to be updated. |
object Options for the DID update operation. | |
| secret | object Object with DID controller keys and other secrets needed to perform the DID update operation. |
| didDocument | object Partial or whole DID document |
| management | any Enum: "SERVER-MANAGED" "USER-MANAGED" "USER-CREATED" |
Responses
Request samples
- Payload
{- "jobId": "6d85bcd0-2ea3-4288-ab00-15afadd8a156",
- "did": "did:didMethod1:WRfXPg8dantKVubE3HX8pw",
- "options": {
- "publicKey": "string",
- "keyResponseMode": "NONE"
}, - "secret": { },
- "didDocument": { },
- "management": "SERVER-MANAGED"
}Response samples
- 200
- 400
- 500
{- "jobId": "6d85bcd0-2ea3-4288-ab00-15afadd8a156",
- "didState": {
- "state": "finished",
- "did": "did:didMethod1:WRfXPg8dantKVubE3HX8pw",
- "secret": {
- "keys": [
- {
- "privateKeyJwk": {
- "kty": "OKP",
- "d": "NzJXR3A3TmdGUjFPcWRpOHpsdDdqUVE0MzRYUjBjTlE",
- "crv": "Ed25519",
- "x": "jpIKKU2b77lNXKTNW2NGvw1GUMjU6v_l_tLJAH5uYz0"
}, - "publicKeyDIDURL": "did:didMethod1:WRfXPg8dantKVubE3HX8pw#key-1"
}
]
}
}, - "didRegistrationMetadata": { },
- "didDocumentMetadata": { }
}Deactivate DID.
Deactivates a DID
query Parameters
| method required | string Example: method=didMethod1 The requested DID method for the operation. |
Request Body schema: application/json
| jobId | string Id of an ongoing DID creation process. |
| did required | string DID to be deactivated. |
| options | object Options for the DID deactivate operation. |
| secret | object Object with DID controller keys and other secrets needed for performing the DID deactivate operation. |
Responses
Request samples
- Payload
{- "jobId": "6d85bcd0-2ea3-4288-ab00-15afadd8a156",
- "did": "did:didMethod1:WRfXPg8dantKVubE3HX8pw",
- "options": { },
- "secret": { }
}Response samples
- 200
- 400
- 500
{- "jobId": "6d85bcd0-2ea3-4288-ab00-15afadd8a156",
- "didState": {
- "state": "finished",
- "did": "did:didMethod1:WRfXPg8dantKVubE3HX8pw",
- "secret": {
- "keys": [
- {
- "privateKeyJwk": {
- "kty": "OKP",
- "d": "NzJXR3A3TmdGUjFPcWRpOHpsdDdqUVE0MzRYUjBjTlE",
- "crv": "Ed25519",
- "x": "jpIKKU2b77lNXKTNW2NGvw1GUMjU6v_l_tLJAH5uYz0"
}, - "publicKeyDIDURL": "did:didMethod1:WRfXPg8dantKVubE3HX8pw#key-1"
}
]
}
}, - "didRegistrationMetadata": { },
- "didDocumentMetadata": { }
}