Encyption Utilities
The API endpoints collected in this section are for version v1 of the Encryption Utilities API.
Encryption Utilities Overview
High-Level Description
Encryption Utilities APIs are intended for the support of other products that require encryption. There are two endpoints currently that both serve the same purpose of delivering a public key on request. That public key can be used for the encrypting of data to be sent to other Card Management APIs.
Encryption
The public key served by these endpoints is used to encrypt data in a format that the receiving APIs can understand. This process is outlined below.
Sometimes Card Management APIs will need to encrypt response data in such a way that only the consumer will be able to read it. In these cases, the flow can be seen below.
Encryption Type
In general, Card Management APIs use JWE encryption for body elements that cannot be transmitted in cleartext. Note: In addition to the parameters below, the key id received from the Retrieve Public Key endpoints must be added as a header. A list of required headers is provided below.
| Header | Value |
|---|---|
| alg | ECDH-ES |
| enc | A256GCM |
| kid | {value from public key endpoint} |
| Numerous guides exist that explain how to implement this process in any language. Most modern programming languages will feature packages that can abstract this encryption. |