Skip to main content

Add account auth key

POST 

/account/auth-keys

Registers another Ed25519 public key for the authenticated account. Use it to rotate keys: register the new key, switch your integration to it, then disable the old key with DELETE /v2/account/auth-keys/{id}.

To prove you own the new key, sign your account ID string with the new key's secret key and send the hex signature as signature.

An account can have up to 5 active keys. This endpoint is rate limited to 5 requests per minute.

Requires authentication: sign the request (see Authentication) or send the legacy x-sideshift-secret header.

Request​

Header Parameters

    x-sideshift-key string

    Your Ed25519 public key, hex encoded. Required when signing the request. See Authentication.

    x-sideshift-timestamp string

    Current Unix time in milliseconds, the same value used in the signed message. Must be within 60 seconds of server time. Required when signing the request.

    x-sideshift-signature string

    Ed25519 signature of timestamp + METHOD + path + body, hex encoded. Required when signing the request. See Authentication.

    x-sideshift-secret string

    Legacy account secret. Not needed when the request is signed with the x-sideshift-key, x-sideshift-timestamp and x-sideshift-signature headers. See Authentication.

Body

required
    pubKeystringrequired

    The new Ed25519 public key, 32 bytes hex encoded.

    signaturestringrequired

    Ed25519 signature of your account ID string, made with the new key's secret key. 64 bytes hex encoded.

Responses​

Auth key registered
Schema
    idstringrequired

    The auth key ID. Used to disable the key.

    pubKeystringrequired

    The public key, hex encoded.

    typestringrequired

    The key type. Currently always ed25519.

    createdAtstring<date-time>required
    disabledAtstring<date-time>

    When the key was disabled. Absent for active keys.