v5

latestOpenAPI 3.1.02026-07-262421791.5 MB
jose

Get Wise JOSE public key

Returns a public key issued by Wise.

Depending on the scope requested, the key will be used for verifying HTTP responses signed by Wise or for for encrypting the payload prior to sending it to Wise.

For both signature verification and payload encryption, the process involves storing this public key after retrieval. In both cases, the stored public key should be used without calling this endpoint.

If verification of the signed request fails or Wise is unable to decrypt your request payload, call this API to issue a fresh key from Wise and reattempt the operation again.

{% admonition type="warning" %} This endpoint requires a client credentials token, not a user level access token. Make sure you use your client details to fetch a valid client credentials token before performing this call. {% /admonition %}

get/v1/auth/jose/response/public-keys

Query parameters

versioninteger

Fetch a specific public key version. If omitted the most recent public key is provided.

algorithm'ES256' | 'ES384' | 'ES512' | 'PS256' | 'PS384' | 'PS512' | 'RSA_OAEP_256' required

Algorithm to be used for signature verification or payload encryption. This must match the algorithm used during request.

  • Signature verification (Scope: PAYLOAD_SIGNING): ES256, ES384, ES512, PS256, PS384, PS512
  • Payload encryption (Scope: PAYLOAD_ENCRYPTION): RSA_OAEP_256
scope'PAYLOAD_SIGNING' | 'PAYLOAD_ENCRYPTION' required

Scope of the key. Must be PAYLOAD_SIGNING or PAYLOAD_ENCRYPTION.

Headers

X-External-Correlation-Idstring uuid

Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Response

Public key object.

keyIdstring UUID

ID of the key in UUID format.

versioninteger

Version of the public key issued.

scope'PAYLOAD_SIGNING' | 'PAYLOAD_ENCRYPTION'

Scope of the key.