This object describes the contents that are sent by nevisFIDO in the out-of-band use case to start an operation (registration, authentication or deregistration).

This object can be obtained from its JSON representation, which is included in a push notification message, in a QR code or in a universal link, depending on the out-of-band mechanism used.

Hierarchy

  • OutOfBandPayload

Properties

contentType: ContentType

The content type of the NMA (Nevis Mobile Authentication) data. The provided content type defines whether the NMA data is encrypted or not.

version: string

The version of the NMA (Nevis Mobile Authentication) data.

This can be used to validate that the contents in the out-of-band payload are compatible with the client.

redeemData: RedeemData

The object containing the redemption information.

data?: string

The optional additional information that it was provided when triggering the out-of-band operation.

Note that the format of the String is defined by the nevisFIDO client triggering the operation: it can be plain text or JSON for example. See the data attribute described in the "Dispatch Token Request Format" section of the nevisFIDO reference guide for additional information.

Methods

Generated using TypeDoc