Behöver du integrera BankID i en app eller på webben? En integration via BankID Integration API är:
Driftsäker
Snabb
Enkel
BankID Integration API
Ett driftsäkert, snabbt och enkelt API för att integrera Mobilt BankID
Marknadens enklaste BankID-API - ca 5 minuters integration (BankID:s eget API tar ca 100 h att integrera)
Inga virtuella maskiner eller certifikatshantering = inga skenande konsultkostnader
Eget BankID-certifikat (ert företagsnamn i BankID-appen)
Dedikerad supporttekniker
Driftsäker, snabb och säker hantering av anrop och data
↓ Klicka här för beskrivning av endpoints↓
Behöver ni integrera Mobilt BankID i ert system? Vårt API är enkelt, säkert och mycket snabbt att integrera - en erfaren programmerare bör kunna göra en första signering eller autentisering inom 5 minuter, oavsett programmeringsspråk.
API:t har två endpoints: 1) Auth/Sign: Används för att autentisera en användare eller för att signera en text eller ett dokument. Du skickar in användarens IP, och får tillbaka en orderreferens, en autostarttoken och en url till en QR-kod. De använder du sedan för att hämta status för signeringen, skapa en länk till BankID-appen eller visa en QR-kod som öppnar BankID-appen.
2) CollectStatus: Används för att hämta status för en signering eller autentisering. Om en signering eller autentisering är under behandling får du status och en "hintCode" som beskriver var i processen användaren befinner sig. När en signering eller autentisering är klar får du personnummer, namn på personen, ip för var den befinner sig och referenskoder som du kan använda för att hämta data om signeringen från BankID i ett senare skede.
För instruktioner om hur du vidarebefordrar användaren direkt från en webbsida eller mobilapp, klicka här.
Nedan följer exempelkod med förklaringar av vilken data som krävs. Kontakta oss gärna om du vill veta mer!
1) Auth/Sign endpoint (POST)
Auth/Sign endpoint JSON:
{
"apiUser":"xxx", // String - username given by BankSignering "password" : "yyy", // String - password guid given by BankSignering "companyApiGuid" : "zzz", // String - company guid given by BankSignering
"endUserIp" : "127.46.85.139" // String - the end user device IP
"userVisibleData" : "Text to sign", // Optional string - If text is to be signed, this is the text shown when signing in the BankID app "userNonVisibleData" : "Non visible text to sign", // Optional string - Text to send to BankID when signing for example a PDF
"getQr" : true // Bool - A dynamic QR code image url for the sign. If getQr is false the sign times out after 30 seconds.
}
Auth/Sign endpoint response JSON:
{
"authResponse": {
"Success": true, // Bool - was the authentification with BankSignering successful? "ErrorMessage": null // String - If something went wrong, what went wrong?
}, "apiCallResponse": { // Null if authentification fails
"Success": true, // Bool - was the send successful? "StatusMessage": "BankId sign initiated", // String - How did the call go? And if something went wrong, what went wrong? "Response": {
"OrderRef": "c1c53baf-9d97-4678-84e2-311c990fad12", // String - The guid to use when getting the sign status later "AutoStartToken": "6a20c02e-fd99-43b8-985d-3fc7b9da1fe3" // String - Use this to forward the user directly to the BankID app. The AutoStartToken is valid 30 seconds after the sign is created. Click here for info on how to create the link. "QrImage": "https://api.banksign.com/qr/3b34k22g-fd99-43b8-985d-3fc7b9da5ht8"
// String - Url to a dynamic QR code image. When the url is opened, the QR code is valid for 10 seconds. If the url is opened more than 200 seconds after the sign is initiated, it returns null. The recommendation
is to reopen the QR code every 5 seconds and adding a time variable to the end of the url, which prevents web browser caching: https://api.banksignering.se/qr/3b34k22g-fd99-43b8-985d-3fc7b9da5ht8?[TIMESTAMP]
}
}
}
2) CollectStatus endpoint (POST)
CollectStatus endpoint JSON:
{
"apiUser":"xxx", // String - username given by BankSignering "password" : "yyy", // String - password guid given by BankSignering "companyApiGuid" : "zzz", // String - company guid given by BankSignering
"orderRef" : "c1c53baf-9d97-4678-84e2-311c990fad12", // String - the orderRef from the response when posting to the Auth/Sign endpoint
}
CollectStatus endpoint response JSON:
{
"authResponse": {
"Success": true, // Bool - was the authentification with BankSignering successful? "ErrorMessage": null // String - If something went wrong, what went wrong?
}, "apiCallResponse": { // Null if authentification fails
"Success": true, // Bool - was the send successful? "StatusMessage": "complete", // String - How did the call go? And if something went wrong, what went wrong? "Response": {
"OrderRef": "c1c53baf-9d97-4678-84e2-311c990fad12", // String - The guid to use when getting the sign status "Status": "complete" // String - The current status of the orderRef: "pending", "failed" or "complete" "HintCode": "null" // String - Hint for pending calls: "outstandingTransaction", "noClient", "started" or "userSign". For failed calls: "expiredTransaction", "certificateErr", "userCancel", "cancelled" or "startFailed". "CompletionData": {
"signature": "*base64-encoded signature data*", // Base64-encoded XML string - The signature data: visibleData, nonVisibleData, reference codes and info about the sign "ocspResponse": "*base64-encoded ocsp data*", // Base64-encoded string - The OCSP response from the BankID certificate "user": {
"personalNumber": "195511237794", // String - The swedish social security number returned by the BankID service "name": "Karl Svensson", // String - User full name "givenName": "Karl", // String - User first name "surname": "Svensson" // String - User surname
}, "device": {
"ipAddress": "85.230.32.204" // String - The ip of the device where the sign was made
En url kan skapas av den autostarttoken man får i svaret från CollectStatus-anropet.
På Android 6 och senare, i iOS och de flesta webbläsare så är URL-syntaxen att föredra: https://app.bankid.com/?autostarttoken=[TOKEN]&redirect=[RETURNURL]
URL-syntax för äldre mobiler: bankid:///?autostarttoken=[TOKEN]&redirect=[RETURNURL]
URL:en fungerar på Android och iOS när den inbyggda webbläsaren används.
Notera att på Android så fungerar app.bankid.com-länken när man använder Google Chrome. Notera att redirect-parametern måste vara sist i parameterlistan. Parameternamnen måste vara i gemener. Notera också att om BankID-appen startas men inget matchande anrop mot BankID-appen gjort så visas ett errormeddelande i BankID-appen.
Offertförfrågan
Fyll i dina företagsuppgifter så skickar vi en offert inom 24 h
Vi använder cookies på vår webbplats för att se hur du interagerar med den samt för att kunna särskilja våra driftmiljöer. När du trycker på Godkänn samtycker du till vår användning av cookies.
Läs vår cookiepolicyJag godkänner användande av cookies
