Interface IBankIdAppApiClient

BankID API Client that defines the supported methods as defined in the document "BankID Relying Party Guidelines".

Namespace: ActiveLogin.Authentication.BankId.Api
Assembly: ActiveLogin.Authentication.BankId.Api.dll
Syntax
public interface IBankIdAppApiClient

Methods

| Improve this Doc View Source

AuthAsync(AuthRequest)

Initiates an authentication order. Use the collect method to query the status of the order.

Declaration
Task<AuthResponse> AuthAsync(AuthRequest request)
Parameters
Type Name Description
AuthRequest request
Returns
Type Description
Task<AuthResponse>

If the request is successful, the OrderRef and AutoStartToken is returned.
| Improve this Doc View Source

CancelAsync(CancelRequest)

Cancels an ongoing sign or auth order. This is typically used if the user cancels the order in your service or app.

Declaration
Task<CancelResponse> CancelAsync(CancelRequest request)
Parameters
Type Name Description
CancelRequest request
Returns
Type Description
Task<CancelResponse>
| Improve this Doc View Source

CollectAsync(CollectRequest)

Collects the result of a sign or auth order using the OrderRef as reference. RP should keep on calling collect every two seconds as long as status indicates pending. RP must abort if status indicates failed.

Declaration
Task<CollectResponse> CollectAsync(CollectRequest request)
Parameters
Type Name Description
CollectRequest request
Returns
Type Description
Task<CollectResponse>

The user identity is returned when complete.
| Improve this Doc View Source

PaymentAsync(PaymentRequest)

Initiates a payment order. Use the collect method to query the status of the order.

Declaration
Task<PaymentResponse> PaymentAsync(PaymentRequest request)
Parameters
Type Name Description
PaymentRequest request
Returns
Type Description
Task<PaymentResponse>

If the request is successful, the OrderRef and AutoStartToken is returned.
| Improve this Doc View Source

PhoneAuthAsync(PhoneAuthRequest)

Initiates a phone authentication order. Use the collect method to query the status of the order.

Declaration
Task<PhoneAuthResponse> PhoneAuthAsync(PhoneAuthRequest request)
Parameters
Type Name Description
PhoneAuthRequest request
Returns
Type Description
Task<PhoneAuthResponse>

If the request is successful, the OrderRef is returned.
| Improve this Doc View Source

PhoneSignAsync(PhoneSignRequest)

Initiates a phone signing order. Use the collect method to query the status of the order.

Declaration
Task<PhoneSignResponse> PhoneSignAsync(PhoneSignRequest request)
Parameters
Type Name Description
PhoneSignRequest request
Returns
Type Description
Task<PhoneSignResponse>

If the request is successful, the OrderRef is returned.
| Improve this Doc View Source

SignAsync(SignRequest)

Initiates a signing order. Use the collect method to query the status of the order.

Declaration
Task<SignResponse> SignAsync(SignRequest request)
Parameters
Type Name Description
SignRequest request
Returns
Type Description
Task<SignResponse>

If the request is successful, the OrderRef and AutoStartToken is returned.

Extension Methods