ID-Card API Documentation¶

We provide a test-environment for Merchants to test the integration. Here we provide with some test users with different age and genders, so that we can generate QRCodes for testing purposes.

Session Response Model¶

We only return the data requested by the scope provided in the access token. The content of the response model will then very depending on the Merchants needs, but a full model looks like this:

Session Response Model

{
    "firstName": "string",
    "lastName": "string",
    "documentPhoto":"string",
    "age": int
}

Here is a table of what you can expect to be returned depending on your scope. All properties will be returned at all times, but the value will be empty if its not part of your scope.

Name	Type	Description	age_only	basic	picture_age	full
firstName	string	First name	❌	✅	❌	✅
lastName	string	Last name	❌	✅	❌	✅
documentPhoto	string (base64)	Identity document's photograph	❌	❌	✅	✅
age	string	Age of user	✅	✅	✅	✅

Warning

This is subject to change. See Release note to stay updated.

Environments¶

ID-Card API is available through different base URLs for our different environments. To access the API, combine the base URL + endpoint like this: base URL + /api/merchant/session/.

Environment URLs - Test¶

ID-Card Base URL: https://visleg-test-merchantservice-cnhvehb0cvdgggah.z01.azurefd.net
BankID OIDC Config: https://auth.current.bankid.no/auth/realms/current/.well-known/openid-configuration

Environment URLs - Production¶

ID-Card Base URL: SENT PRIVATELY
BankID OIDC Config: https://auth.bankid.no/auth/realms/prod/.well-known/openid-configuration

Merchant Integration API¶

Testing

For documentation on how to use QRCode test endpoint, see Testing the API

Live API documentation

The live API swagger documentation for the ID-Card API can be found here. This can deviate from this documentation as it us under development.