Create AES key (encrypted response)

Create an Advanced Encryption Standard (AES) key using bulk ID.

This endpoint uses JSON Web Encryption (JWE) to encrypt the response body at the message level. It takes a public_key_id, which refers to the public key you have already uploaded to the Pismo platform. Pismo uses this key to encrypt the response payload in accordance with the standard JWE protocol. To decrypt the response, you must use the corresponding private key. For information about file encryption and AES keys, refer to the File encryption section in File signature and encryption.

The decrypted plaintext is a JSON object with fields:

{
  "aes_key": "245ca959580cae6317c8f8215cbae42c8b98bbf30d9f222b92db30df81a06f91"
  "iv": "7b75d3b5a25e9651e69245fa844cf3ec"
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the existing bulk payment file. This ID is client-generated.

Body Params

Create AES key request body

Create AES key request object

string
required
≤ 60

ID of the public key. Only digits, letters, hyphens, and underscores are allowed, and cannot exceed 60 characters.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Access token is missing or invalid

403

The request has been lost

404

Not Found

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/jose
application/json