Authentication

Get a key


Key	management management::read
Throttle	account
Cost	1 /request
Answers	<span class="st st-ok">200</span> <span class="st st-warn">401</span> <span class="st st-warn">403</span> <span class="st st-warn">404</span> <span class="st st-hold">423</span> <span class="st st-hold">429</span> <span class="st st-warn">451</span>
Idempotent	true

get/v3/keys/{id}

Request

Base URL: https://api.paper.novig.com
URL: https://api.paper.novig.com/v3/keys/{id}
Auth: API key in header Novig-Key-Id and API key in header Novig-Signature and API key in header Novig-Timestamp

Path parameters

idstring uuid required

Key ID.

Response

The key.

algorithm'Ed25519' | 'P-256' required

The signing algorithm of the stored public key. Your signer must match it.

createdAtstring date-time required

expiresAtstring date-time nullable required

fingerprintstring required

sha256: and the hex SHA-256 of the SPKI DER.

keyIdstring uuid required

lastUsedAtstring date-time nullable required

Reserved. Always null.

namestring required

restrictionstring nullable required

Non-null on a trading or trading::read key: the subaccount's label. A flag, not an address.

scope'trading' | 'trading::read' | 'management' | 'management::read' required

A key's one scope. Every route but one fixes the scope it mints. POST /v3/account/subaccounts/{keyId}/keys is the exception. Its body names trading or trading::read.

Example response

{
  "fingerprint": "sha256:6d4058ea55f365a60868b7a29f302deee40cd738f1ee98f14f43381c13f1a232"
}

Changes

No recorded changes to this operation across all 1 revision of this API.