Class PhoneRequest

Inheritance

System.Object

PhoneRequest

Namespace: ActiveLogin.Authentication.BankId.Api.Models

Assembly: ActiveLogin.Authentication.BankId.Api.dll

Syntax

public abstract class PhoneRequest : object

Constructors

| Improve this Doc View Source

PhoneRequest(String, CallInitiator, Nullable<String>, Byte[], PhoneRequirement, Nullable<String>)

Declaration

public PhoneRequest(string personalIdentityNumber, CallInitiator callInitiator, string? userVisibleData, byte[] userNonVisibleData, PhoneRequirement requirement, string? userVisibleDataFormat)

Parameters

Type	Name	Description
System.String	personalIdentityNumber	The personal number of the user. String. 12 digits.
CallInitiator	callInitiator	Indicate if the user or the RP initiated the phone call. user: user called the RP. RP: RP called the user.
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.
PhoneRequirement	requirement	Requirements on how the phone auth or phone 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.

| Improve this Doc View Source

PhoneRequest(String, CallInitiator, String)

Declaration

public PhoneRequest(string personalIdentityNumber, CallInitiator callInitiator, string userVisibleData)

Parameters

Type	Name	Description
System.String	personalIdentityNumber	The personal number of the user. String. 12 digits.
CallInitiator	callInitiator	Indicate if the user or the RP initiated the phone call. user: user called the RP. RP: RP called the user.
System.String	userVisibleData	The text to be displayed and signed. The text can be formatted using CR, LF and CRLF for new lines.

| Improve this Doc View Source

PhoneRequest(String, CallInitiator, String, Byte[])

Declaration

public PhoneRequest(string personalIdentityNumber, CallInitiator callInitiator, string userVisibleData, byte[] userNonVisibleData)

Parameters

Type	Name	Description
System.String	personalIdentityNumber	The personal number of the user. String. 12 digits.
CallInitiator	callInitiator	Indicate if the user or the RP initiated the phone call. user: user called the RP. RP: RP called the user.
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.

| Improve this Doc View Source

PhoneRequest(String, CallInitiator, String, Byte[], PhoneRequirement)

Declaration

public PhoneRequest(string personalIdentityNumber, CallInitiator callInitiator, string userVisibleData, byte[] userNonVisibleData, PhoneRequirement requirement)

Parameters

Type	Name	Description
System.String	personalIdentityNumber	The personal number of the user. String. 12 digits.
CallInitiator	callInitiator	Indicate if the user or the RP initiated the phone call. user: user called the RP. RP: RP called the user.
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.
PhoneRequirement	requirement	Requirements on how the phone auth or phone sign order must be performed.

| Improve this Doc View Source

PhoneRequest(String, CallInitiator, String, String, Byte[])

Declaration

public PhoneRequest(string personalIdentityNumber, CallInitiator callInitiator, string userVisibleData, string userVisibleDataFormat, byte[] userNonVisibleData)

Parameters

Type	Name	Description
System.String	personalIdentityNumber	The personal number of the user. String. 12 digits.
CallInitiator	callInitiator	Indicate if the user or the RP initiated the phone call. user: user called the RP. RP: RP called the user.
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 Source

CallInitiator

Indicate if the user or the RP initiated the phone call. user: user called the RP. RP: RP called the user.

Declaration

public string CallInitiator { get; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

PersonalIdentityNumber

The personal number of the user. String. 12 digits.

Declaration

public string PersonalIdentityNumber { get; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Requirement

Requirements on how the phone auth or phone sign order must be performed.

Declaration

public PhoneRequirement Requirement { get; }

Property Value

Type	Description
PhoneRequirement

| Improve this Doc View Source

UserNonVisibleData

Data not displayed to the user.

Declaration

public string? UserNonVisibleData { get; }

Property Value

Type	Description
System.Nullable<System.String>

| Improve this Doc View Source

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>

| Improve this Doc View Source

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>