Saltar para a documentação
API

Publicar uma chave pública

Permite aos remetentes selar o correio para um dos seus endereços.

POST/encryption/keys

Executa a chamada real no seu espaço de trabalho.

POST /encryption/keys

Permite aos remetentes selar o correio para um dos seus endereços.

Exemplo

Precisa de emails:read. address é um dos seus endereços num domínio verificado, publicKey a chave pública OpenPGP em formato armadura e fingerprint os seus 40 caracteres hexadecimais em maiúsculas. Responde 201 com a chave.

curl
curl -X POST "$OE/encryption/keys" -H "$AUTH" -H "Content-Type: application/json" \  -d '{ "address": "[email protected]", "publicKey": "-----BEGIN PGP PUBLIC KEY BLOCK-----\n…", "fingerprint": "3F2A9C1B7E4D5F60A1B2C3D4E5F60718293A4B5C" }'
Resposta
{  "object": "encryption_key",  "id": "pgpk_8c1e4a7f2b9d3e6a0c5f1b28",  "address": "[email protected]",  "fingerprint": "3F2A9C1B7E4D5F60A1B2C3D4E5F60718293A4B5C",  "publicKey": "-----BEGIN PGP PUBLIC KEY BLOCK-----\n…\n-----END PGP PUBLIC KEY BLOCK-----",  "algorithm": "ed25519",  "createdAt": "2026-09-30T09:12:44.000Z",  "revokedAt": null,  "revokedReason": null}

Um endereço mantém uma única chave ativa. Publicar outra é um 409 key_already_published, por isso, para a rodar, envie a impressão digital da chave ativa em replaces, e ela é retirada quando a nova fica ativa. O correio já selado com a chave antiga só pode ser lido com a chave privada antiga.

Uma aplicação pede primeiro um código de verificação: até ter verificado um, a chamada responde 403 step_up_required. A uma chave de API nunca é pedido.

Aqui só circula a chave pública. A chave privada fica no dispositivo que a criou.

Referência