Input
Name | Type | Description | Mandatory | Available from version |
---|---|---|---|---|
OrderReference | String | A reference that is used to identify a certain authentication. The reference is obtained when calling BankIdAuthentication | true | |
Domain | Enum | Front: End customer that should be authenticated Partner: Partner that should be authenticated Admin: Admin that should be authenticated | false | |
BankIdType | Enum |
Mobile: |
If |
the |
user |
is |
authenticated |
via |
mobile |
BankID |
File: If the user is authenticated through BankID on file |
...
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 | true |
|
Response
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 | |||||||||
ProgressStatus | Enum | For more information on the statuses returned: BankID Relying Party Guidelines 12.8.3 https://www.bankid.com/bankid-i-dina-tjanster/rp-info | |||||||
Status | String | To know the status of the Auth or BankId request | |||||||
Signature | String | The signature as described in the BankID Signature Profile specification. String. Base64-encoded. XML signature | |||||||
SignText | String | The text that should be shown to the user when signing | |||||||
CompletionData | CompletionData | A final state when an order is successful. The completionData includes signature, user information and the OCSP response. RP should verify user information to proceed |
| ||||||
QRCodes | QRCode[] | Array of QRCodes. Each QRCode consists of: String Code : Code generated for the QRCode. int Time : Basically, its count how many code generated. |
|