End to end encryption of sensitive data like passwords and OTP is a security mandate in some countries. The /security resource allows you to exchange keys which are used for encryption and decryption. Key exchange methods differ depending on whether you already have a registered key or whether you need Citi to send you a key which can be used for encryption. You will receive eventID in the API response header, which should be used to encrypt the sensitive data. All encrypted data sent to Citi will give you an additional eventID in response header, this new eventID should be used for further encryptions.
Custom Gateway API Endpoint
Paths
/v1/security/encryption/e2eKey
Retrieves a E2E public key modulus and exponent.
This API is used by browser based applications for retrieving the public key used for encryption. It returns the modulus and exponent for setting up a business public key. This is a post login API
pv52735
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
128 bit random UUID generated uniquely for every request.
Content-Type that are acceptable for the response.
Client ID generated during application registration.
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
Function or flow for which the public key used for encryption is required.
Successful operation.
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid Parameters |
| error | cannotRetrieveKeyInfo | cannot retrieve public key. |
| error | e2eDisabled | E2E is disabled. |
| error | unAuthorized | Authorization credentials are missing or invalid |
| error | accessNotConfigured | The request operation is not configured to access this resource |
| error | resourceNotFound | Empty resource/resource not found |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |