Payload Encoding

Describes the request/response payload encoding

Payload Encoding

The following encoding formats are supported in the REST API.

For every encoding, the resultant protected data is returned in the same encoding. For example, if request is hex-encoded, the response is also hex-encoded.

For more information about the encoding formats, refer to the Protection Methods Reference.

Encoding

Supported by data elements

Notes

utf8

All except binary data elements.

Default encoding if encoding is not specified.

hex

All

Default encoding for binary data elements.

base64

All

base64_mime

All

  • Uses RFC 2045 Alphabet.
  • Accepts input on multiple lines.
  • Lines can be separated by any combination of CR and LF characters.
  • Lines must not be longer than 76 characters long.
  • Response lines are separated by CRLF characters.
  • Optional padding.
  • Does not accept any non-base64 characters.

base64_pem

All

  • Uses RFC 1421 Alphabet.
  • Accepts input on multiple lines.
  • Lines can be separated by any combination of CR and LF characters.
  • Lines must not be longer than 64 characters long.
  • Response lines are separated by CRLF characters.
  • Optional padding.
  • Does not accept any non-base64 characters.

base64_url

All

The following sections provide the payload schema and its examples.

Last modified : January 08, 2026