Add Request

Creates and sends a challenge request to a user.

If you are using Privakey AuthWallet instead of your own licensed app, then you must use a request template. You do so by setting the additionalInfo param to {"template":true} and setting the content to JSON with a title and a keys array of key value pairs, E.G. {"title":"A new Request!","keys":[{"key":"This is a key","value":"This is a value"}]}

Buttons are optional, and, if not specified, two buttons will be defaulted on the request - Approve (strong auth is required), and Reject (strong auth is not required). If buttons are specified, then at least two buttons, each with title and strongAuth parameters must be set. Style is always optional, but if set, must be a string. Please note: the Auth Service does not interact at all with the styles, and they must be handled by the implementing App.

If a Callback is specified, the callback must have been white listed in the configuration of the calling Request Origin's data in the Admin Portal. Once the request is processed, the URI specified in the callback will receive the processed request's data. For more information, see the documentation on Callbacks.

If you aren't using AuthWallet, additionalInfo is a field to put any extra data. The data will not be interacted with by the Auth Service, but it will always be returned back along with the rest of the request data. It is useful to send meta data and context information about the request.

notificationBody and notificationTitle are defaulted to values set in the database configuration if not provided.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Form Data
string
required

The user's account id in your system

buttons
array of strings

An array of strings or JSON objects representing buttons. A button requires a string title and a strongAuth boolean flag. Optionally, a style can be sent too, which must be a string.

buttons
string

Any additional info you want to send with the request. This info will be linked to the request and can be used to include custom information. If using Privakey AuthWallet instead of your own licensed app, then you must use a Privakey request template. You can enable this by setting additionalInfo to {"template":true}

string

The callback the Auth Service will call when a request is processed. This callback must be preconfigured in the Admin Portal, otherwise the request will be rejected.

string

A value denoting the length of time the request challenge is valid. A number with an acceptable unit of time. Acceptable units of time are s for seconds, m for minutes, h for hours, or d for days. E.G. "24h" = 24 hours (Default: "60s")

string

The text to be displayed in the body of a notification for the request challenge. (Default: "Authentication Request")

string

The text to be displayed in the title of a notification for the request challenge. (Default: "Authentication Request")

string

The main content of the challenge to be presented to the user.

string

A value to record the transaction of the request, in the case where it must be matched against other systems.

boolean

A flag indicating whether the confirmation code is intended to be displayed on the request or not. (Default: false)

boolean

A flag indicating whether the notification should be displayed to the end user, or silently consumed by the App. (Default: false)

Headers
string
required

Either Basic or HMAC, depending on how the Request Origin is configured.

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json