Input
Name | Type | Description | Mandatory | Available from version |
|---|---|---|---|---|
PersonalNumber | String | The personal number of the person to authenticate | true |
|
BankIdType | Enum | Mobile: If the user is authenticated via mobile BankID File: 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 | true |
|
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 | false | 2.09 |
Outputs
Name | Type | Description | Available from version |
|---|---|---|---|
PersonalNumber | String | The personal number of the person to authenticate |
|
BankIdType | Enum | Mobile: If the user is authenticated via mobile BankID File: If the user is authenticated through BankID on file | |
OrderReference | String | A reference that is used to identify a certain authentication. The Orderreference is sent with the call to GetBankIdStatus | |
AuthToken | String | Sends in the beginning with BankID app. For more information: https://www.bankid.com/bankid-i-dina-tjanster/rp-info | |
QRCodes | A reference used to identify with code and time. | IN DEVELOPMENT | |
StartTime | DateTime | To identify the start time of the Authentication | IN DEVELOPMENT |
Code examples
XML request example
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<BankIdAuthentication xmlns="http://tempuri.org/">
<req>
<Credentials>
<UserName>yourusername</UserName>
<Password>yourpassword</Password>
</Credentials>
<identify>youridentifier</identify>
<Domain>Front</Domain>
<BankIdType>Mobile</BankIdType>
<AuthenticatePerson>true</AuthenticatePerson>
</req>
</BankIdAuthentication>
</s:Body>
</s:Envelope>