19. Skip to content

19. API Reference for capsule server

CDOC2 API References are available at the Open Electronic Identity GitHub CDOC2 Openapi repo

Capsule Server Opeanapi spec

19.1 API usage samples

19.1.1 Create Capsule

Request:

POST /key-capsules
Content-Type: application/json
x-expiry-time: 2026-08-10T00:00:00Z

{
"recipient_id": "BHy8k3F2v9pQmR7tL4nW1cXeZ0aB8dY6gH3jK5mN2pQ7rS9tU1vW3xY5zA7bC9dE1fG3hJ5kL7mN9pQ==",
"ephemeral_key_material": "BAy8k3F2v9pQmR7tL4nW1cXeZ0aB8dY6gH3jK5mN2pQ7rS9tU1vW3xY5zA7bC9dE1fG3hJ5kL7mN9pQ==",
"capsule_type": "ecc_secp256r1"
}

Response:

HTTP/1.1 201 Created
Location: /key-capsules/KC0123456789ABCDEF
x-expiry-time: 2026-08-10T00:00:00Z
x-expiry-time-adjusted: false

19.1.2 Retrieve Capsule

Request:

GET /key-capsules/KC0123456789ABCDEF

Response:

HTTP/1.1 200 OK
Content-Type: application/json
x-expiry-time: 2026-08-10T00:00:00Z

{
  "recipient_id": "BHy8k3F2v9pQmR7tL4nW1cXeZ0aB8dY6gH3jK5mN2pQ7rS9tU1vW3xY5zA7bC9dE1fG3hJ5kL7mN9pQ==",
  "ephemeral_key_material": "BAy8k3F2v9pQmR7tL4nW1cXeZ0aB8dY6gH3jK5mN2pQ7rS9tU1vW3xY5zA7bC9dE1fG3hJ5kL7mN9pQ==",
  "capsule_type": "ecc_secp256r1"
}