AusweisApp is an electronic ID supported in Germany that can read end user's ID Cards that are machine readable through an external smart card reader hardware or mobile device that has an NFC reader available, with the help of AusweisApp installed on PC/Mobile devices, enabling end users to identify digitally in a secure way.
Enable AusweisApp in your services
Information about the end user
Document Type
| personalausweis.
document_type
| PERSONALAUSWEIS.
DOCUMENT_TYPE
| Type of document of end user’s card
|
Issuing State
| personalausweis.
issuing_state
| PERSONALAUSWEIS.
ISSUING_STATE
| Issuing state of end user’s card |
Date Of Expiry
| personalausweis.
date_of_expiry
| PERSONALAUSWEIS.
DATE_OF_EXPIRY
| Date of expiry of end user’s card |
Given Names
| personalausweis.
given_names
| PERSONALAUSWEIS.
GIVEN_NAMES
| Name of end-user
|
Family Names
| personalausweis.
family_names
| PERSONALAUSWEIS.
FAMILY_NAMES
| Family name of end-user |
Artistic Name
| personalausweis.
artistic_name
| PERSONALAUSWEIS.
ARTISTIC_NAME
| Artistic name of end-user
|
Academic Title
| personalausweis.
academic_title
| PERSONALAUSWEIS.
ACADEMIC_TITLE
| Academic title of end-user
|
Date of Birth
| personalausweis.
date_of_birth
| PERSONALAUSWEIS.
DATE_OF_BIRTH
| Date of birth of end-user
|
Place of Birth
| personalausweis.
place_of_birth
| PERSONALAUSWEIS.
PLACE_OF_BIRTH
| Place of birth of end-user
|
Place of Birth.Text
| personalausweis.
place_of_birth.text
| PERSONALAUSWEIS
.PLACE_OF_BIRTH.TEXT
| Place of birth of end-user in free text format |
Nationality
| personalausweis.
nationality
| PERSONALAUSWEIS.
NATIONALITY
| Nationality of end-user |
Birth Name
| personalausweis.
birth_name
| PERSONALAUSWEIS.
BIRTH_NAME
| Birth name of end-user
|
Place of Residence
| personalausweis.
place_of_residence
| PERSONALAUSWEIS.
PLACE_OF_RESIDENCE
| Place of residence of end-user |
Place of Residence.Text
| personalausweis.
place_of_residence.text
| PERSONALAUSWEIS.
PLACE_OF_RESIDENCE.TEXT
| Place of residence of end-user in free text format
|
Community ID
| personalausweis.
community_id
| PERSONALAUSWEIS.
COMMUNITY_ID
| Community ID of end-user |
User Experience
Step 1: Below is the first screen during AusweisApp identification. End users who do not have the AusweisApp installed on their PC/Mobile device can install the app from the link provided in the UI. The link takes the users to the official site for downloading the AusweisApp. If end users have the
AusweisApp installed, then they can proceed by clicking the Next button.
Step 2: The end users shall keep the card, card reader ready and click the Authenticate button.
Step 3: After clicking the Authenticate button,
AusweisApp installed on the end users device gets triggered. In some cases, if the
AusweisApp is not running in the background then the app needs to be opened by the end users manually. E-Ident UI is shown below during this process.
Step 4: The
AusweisApp shows the below information once it is triggered in the above steps. Below is an example from
AusweisApp on PC.
Step 5: After knowing to whom you are identifying from the above step and giving read access to some of the fields displayed on the screen, clicking on “Proceed to PIN entry” takes the user through below sequence. Below is an example from mobile app.
Step 6: Place the card at the back of your mobile device (that supports NFC scan) to start reading the card through
AusweisApp.
Step 7: After successfully reading the card, enter your PIN for the card to complete the identification.
Installation & Usage of Ausweis Simulator - PersoSim
Identification with AusweisApp idp on E-Ident service can be tested using PersoSim simulator without the need for possessing a card reader hardware and Ausweis test smart cards by utilizing virtual card reader hardware and test cards provided by this simulator.
Steps for installing and configuring the PersoSim simulator are as below.
- Download the driver for virtual card reader from
https://persosim.github.io/#downloads-und-installation depending on the OS you are using.
- From the same site
https://persosim.github.io/#downloads-und-installation download the PersoSim simulator relevant to the OS you are using.
- Unzip the zip file downloaded for virtual card reader driver and run the .exe file and follow the instructions to install the driver. It is fine if there are installation errors.
- Unzip the zip file downloaded for the simulator and run the “PersoSim.exe" file. The launch should be successful on its own.
- If there are any errors in the above step, please make sure that Java 17 is installed on your machine. Also ensure to set JAVA_HOME and JAVA_PATH system environment variables to point to Java 17 installation directory on your PC. Then try running the PersoSim.exe file and the launch should be successful.
- On the PersoSim GUI, navigate to “Reader Type" and select “Configure RemoteIFD". Click on “Start pairing". A code will be displayed for pairing.
- Now open the AusweisApp installed on your PC, navigate to Settings -> “Smartphone as card reader". After few seconds being on this screen, the virtual card reader hardware “PersoSim" gets displayed here. Click on pair and enter the code for pairing.
- Now the virtual card reader is ready (PersoSim GUI) and can be used to test identification with AusweisApp on E-Ident Service.
- To get different virtual cards for testing identification, you can choose various PersoSim profiles under “Personalization" section on the PersoSim GUI
