v5

latestOpenAPI 3.1.02026-07-262421791.5 MB
jose

Add a new client public key

Upload a client public key for request payload signing or response payload encryption.

{% 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 %}

post/v1/auth/jose/request/public-keys

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.

Request body

keyIdstring uuid

Unique public key identifier in UUID format.

validFromstring

The key is valid from this date. Format: yyyy-MM-dd HH:mm:ss (UTC).

validTillstring

The key is valid until this date. Format: yyyy-MM-dd HH:mm:ss (UTC).

scope'PAYLOAD_SIGNING' | 'PAYLOAD_ENCRYPTION'

Scope of the payload operation.

Response

Public key created successfully.

clientIdstring nullable

This field is currently not in use and will always return null.

keyIdstring uuid

Unique public key identifier in UUID format.

scope'PAYLOAD_SIGNING' | 'PAYLOAD_ENCRYPTION'

Scope of the payload operation.

validFromstring

The key is valid from this date. Format: yyyy-MM-dd HH:mm:ss (UTC).

validTillstring

The key is valid until this date. Format: yyyy-MM-dd HH:mm:ss (UTC).

deactivationTimestampstring nullable

This field is currently not in use and will always return null.