Example API

Use the Access Token

An Access Token must be supplied on every request to a HYPR API HTTP endpoint. The request will fail if the token is missing or does not have permissions for the requested operation. The request will also fail if the token has expired, has been revoked, or is invalid.

Access Tokens must be sent in the Authorization header using the Bearer schema.

Here is an example cURL command to pass Access Token 7c839b65-9d28-4037-afc6-993fc5595cbf:

curl https://staging1.gethypr.com/cc/api/stats/authenticator/logins \
  -H 'Authorization: Bearer 7c839b65-9d28-4037-afc6-993fc5595cbf'

Access Tokens in HYPR SDK for Java

The following HYPR SDK for Java commands show the usage of Access Tokens.

//Registration
java -jar java-client-<version>.jar REGISTER https://<your_hypr_server_url>.com <api_access_token> highlandsBank username

//Authentication
java -jar java-client-<version>.jar AUTHENTICATE https://<your_hypr_server_url>.com <api_access_token> highlandsBank username

//Transaction
java -jar java-client-<version>.jar TRANSACTION https://<your_hypr_server_url>.com <api_access_token> highlandsBank username actionId transactionType transactionText

Registration

Navigate to the folder where the HYPR SDK for Java package is downloaded (or placed). To register an email address use the following command:

java -jar java-client-<version>.jar REGISTER https://<your_hypr_server_url>.com <api_access_token> highlandsBank username
For example: java -jar java-client-3.8.0-20200117.161944-11.jar REGISTER https://awsdevelop1.biometric.software 001fc0cf-0703-fb7d-ad44-07c7e3334bcb highlandsBank [email protected]

A QR code will be generated in your HOME directory.

QR code file (QR.png):

Authentication

To authenticate the registered email address:

java -jar java-client-<version>.jar AUTHENTICATE https://<your_hypr_server_url>.com <api_access_token> highlandsBank username
For example: java -jar java-client-3.8.0-20200117.161944-11.jar AUTHENTICATE https://awsdevelop1.biometric.software 001fc0cf-0703-fb7d-ad44-07c7e3334bcb highlandsBank [email protected]

A push notification will be generated. After successful FIDO operations, the user will be authenticated.

Transaction

To post a transaction on the registered email address:

java -jar java-client-<version>.jar TRANSACTION https://<your_hypr_server_url>.com <api_access_token> highlandsBank username actionId transactionType transactionText
For example: java -jar java-client-3.8.0-20200117.161944-11.jar TRANSACTION https://awsdevelop1.biometric.software 001fc0cf-0703-fb7d-ad44-07c7e3334bcb highlandsBank [email protected] completeMediumTransaction Wire $500

actionId: Policy name
transactionType and transactionText: Enter custom text

FIDO RP API

HYPR SDK for Java includes full API functionality for FIDO RP calls. HYPR provides a Postman list describing the details of the various FIDO RP API calls.