Inputs

Name	Type	Description	Mandatory	Available from version

Name	Type	Description	Mandatory	Available from version
BankIdType	Enum	^{BankIdMobile: If the user is authenticated via mobile BankID} BankIdFile: If the user is authenticated through BankID on file or card	True
Domain	Enum	Front: End customer that should be authenticated Partner: Partner that should be authenticated Admin: Admin that should be authenticated	False	removed (2024-04-24)
PersonalNumber	string	The personal number of the person to authenticate	false	Removed (2024-04-24)
SigningText	string	The text that should be shown to the user when signing		2.11
AuthenticatePerson	Boolean (nullable)	If set to true or null the personal number passed in the request must exist on a person in BFS. If set to false the personal number does not have to exist on a person in BFS		removed (2024-04-24)

Response rows

Name	Type	Description	Available from version

Name	Type	Description	Available from version
OrderReference	string	A reference that is used to identify a certain authentication and is used with GetBankIdStatus in order to get the result of the signing
AuthToken	string	The unique token of the BankId call
BankIdType	Enum	^{BankIdMobile: If the user is authenticated via mobile BankID} BankIdFile: If the user is authenticated through BankID on file
PersonalNumber	string	The personal number of the person to authenticate	Removed (2024-04-24)
QRCodes	QRCode[]	Array of QRCodes. Each QRCode consists of: String Code : Code generated for the QRCode. int Time : The order in which the QR code is to be displayed to the user.	2024-04-29
StartTime	DateTime	To identify the start time of the BankIdSign.	2024-04-29

Request example

XML - BankIdSign


<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <BankIdSign xmlns="http://tempuri.org/">
      <req>
        <Credentials>
          <UserName>username</UserName>
          <Password>password</Password>
          </Credentials>
          <identify>identify</identify>
        <SigningText></SigningText>
        <BankIdType>Mobile</BankIdType>
        <AuthenticatePerson>true</AuthenticatePerson>
      </req>
    </BankIdSign>
  </soap:Body>
</soap:Envelope>

Code examples

C# - Get all account types from a BFS instance

//Create BankIdSign
var client = new BFSServiceReference.bfsapiSoapClient();

var credentials = new BFSServiceReference.Credentials()
{
    UserName = bfsusername, //Username of administrative user in your instance of BFS
    Password = bfspassword, //Password of the administrative user in your instance of BFS
};

var response = client.BankIdSign(new BFSServiceReference.BankIdSignRequest()
{
    Credentials = credentials,

    identify = bfsidentifier, //Identifier is a unique token for your instance of BFS    

    BankIdType = BankIdType.Mobile,
    Domain = Domain.Admin,
    SigningText = "The signing text"
   
});

Console.WriteLine(response.OrderReference, response.AuthToken, response.BankIdType, response.PersonalNumber);

Blog stream

Create a blog post to share news and announcements with your team and company.