Class Request
Namespace: ActiveLogin.Authentication.BankId.Api.Models
Assembly: ActiveLogin.Authentication.BankId.Api.dll
Syntax
public abstract class Request : object
Constructors
| Improve this Doc View SourceRequest(String, Nullable<String>, Byte[], Requirement, Nullable<String>, Nullable<String>, Nullable<Boolean>, Nullable<List<String>>, UserVisibleTransaction, DeviceDataWeb, DeviceDataApp)
Declaration
public Request(string endUserIp, string? userVisibleData, byte[] userNonVisibleData, Requirement requirement, string? userVisibleDataFormat, string? returnUrl = null, bool? returnRisk = null, List<string>? riskFlags = null, UserVisibleTransaction userVisibleTransaction = 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.Nullable<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. |
System.Nullable<List<System.String>> | riskFlags | Indicate to the risk assessment system that the payment has a higher risk or is unusual for the user. List of String. Possible values: newCard, newCustomer, newRecipient, highRiskRecipient, largeAmount, foreignCurrency, cryptoCurrencyPurchase, moneyTransfer, overseasTransaction, recurringPayment, suspiciousPaymentPattern, other |
UserVisibleTransaction | userVisibleTransaction | Information about the transaction being approved. |
DeviceDataWeb | web | Information about the web browser the end user is using. |
DeviceDataApp | app | Information about the App device the end user is using. |
Request(String, String)
Declaration
public Request(string endUserIp, string userVisibleData)
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. |
Request(String, String, Byte[])
Declaration
public Request(string endUserIp, string userVisibleData, byte[] userNonVisibleData)
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. |
Request(String, String, Byte[], Requirement)
Declaration
public Request(string endUserIp, string userVisibleData, byte[] userNonVisibleData, Requirement requirement)
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. |
Request(String, String, String, Byte[])
Declaration
public Request(string endUserIp, string userVisibleData, string userVisibleDataFormat, byte[] userNonVisibleData)
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.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.Byte[] | userNonVisibleData | Data not displayed to the user. |
Properties
| Improve this Doc View SourceApp
Declaration
public DeviceDataApp App { get; set; }
Property Value
Type | Description |
---|---|
DeviceDataApp |
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.
Declaration
public string EndUserIp { get; }
Property Value
Type | Description |
---|---|
System.String |
Requirement
Requirements on how the auth or sign order must be performed.
Declaration
public Requirement Requirement { get; }
Property Value
Type | Description |
---|---|
Requirement |
ReturnRisk
If this is set to true, a risk indication will be included in the collect response when the order completes.
Declaration
public bool? ReturnRisk { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Boolean> |
ReturnUrl
Orders started on the same device (started with autostart token) will call this URL when the order is completed, ignoring any return URL provided in the start URL when the BankID app was launched.
Declaration
public string? ReturnUrl { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.String> |
RiskFlags
Indicate to the risk assessment system that the payment has a higher risk or is unusual for the user. List of String. Possible values: newCard, newCustomer, newRecipient, highRiskRecipient, largeAmount, foreignCurrency, cryptoCurrencyPurchase, moneyTransfer, overseasTransaction, recurringPayment, suspiciousPaymentPattern, other
Declaration
public List<string>? RiskFlags { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<List<System.String>> |
UserNonVisibleData
Data not displayed to the user.
Declaration
public string? UserNonVisibleData { get; }
Property Value
Type | Description |
---|---|
System.Nullable<System.String> |
UserVisibleData
The text can be formatted using CR, LF and CRLF for new lines. The text must be encoded as UTF-8 and then base 64 encoded. 1—1 500 characters after base 64encoding.
Scenario sign: The text to be displayed and signed. String. The text can be formatted using CR, LF and CRLF for new lines.
Scenario auth: A text that is displayed to the user during authentication with BankID, with the purpose of providing context for the authentication and to enable users to notice if there is something wrong about the identification and avoid attempted frauds.
Declaration
public string? UserVisibleData { get; }
Property Value
Type | Description |
---|---|
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.
Declaration
public string? UserVisibleDataFormat { get; }
Property Value
Type | Description |
---|---|
System.Nullable<System.String> |
UserVisibleTransaction
Information about the transaction being approved.
Declaration
public UserVisibleTransaction UserVisibleTransaction { get; set; }
Property Value
Type | Description |
---|---|
UserVisibleTransaction |
Web
Declaration
public DeviceDataWeb Web { get; set; }
Property Value
Type | Description |
---|---|
DeviceDataWeb |