Class SignRequest
Sign request parameters.
Inherited Members
Namespace: ActiveLogin.Authentication.BankId.Api.Models
Assembly: ActiveLogin.Authentication.BankId.Api.dll
Syntax
public class SignRequest : Request
Constructors
| Improve this Doc View SourceSignRequest(String, String, Byte[], Requirement, Nullable<String>, Nullable<String>, Nullable<Boolean>, DeviceDataWeb, DeviceDataApp)
Declaration
public SignRequest(string endUserIp, string userVisibleData, byte[] userNonVisibleData = null, Requirement requirement = null, string? userVisibleDataFormat = null, string? returnUrl = null, bool? returnRisk = null, DeviceDataWeb web = null, DeviceDataApp app = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | endUserIp | The user IP address as seen by RP. IPv4 and IPv6 is allowed. Note the importance of using the correct IP address.It must be the IP address representing the user agent (the end user device) as seen by the RP. If there is a proxy for inbound traffic, special considerations may need to be taken to get the correct address. In some use cases the IP address is not available, for instance for voice based services. In this case, the internal representation of those systems IP address is ok to use. |
System.String | userVisibleData | The text to be displayed and signed. The text can be formatted using CR, LF and CRLF for new lines. |
System.Byte[] | userNonVisibleData | Data not displayed to the user. |
Requirement | requirement | Requirements on how the auth or sign order must be performed. |
System.Nullable<System.String> | userVisibleDataFormat | If present, and set to "simpleMarkdownV1", this parameter indicates that userVisibleData holds formatting characters which, if used correctly, will make the text displayed with the user nicer to look at. For further information of formatting options, please study the document Guidelines for Formatted Text. |
System.Nullable<System.String> | returnUrl | The URL to return to when the authentication order is completed. |
System.Nullable<System.Boolean> | returnRisk | If set to true, a risk indication will be included in the collect response. |
DeviceDataWeb | web | Information about the app device the end user is using. |
DeviceDataApp | app | Information about the web browser the end user is using. |