Vipps Userinfo API (2.0.3)

Download OpenAPI specification:Download

Vipps offers the possibility for merchants to ask for the user's profile information as part of the payment flow. This follows the OIDC Standard: UserInfo endpoint. See the Userinfo API guide for a description.

Get Userinfo

This endpoint returns the payload with the information that the user has consented to share. Find more info on the /userinfo endpoint at the OIDC Standard.

path Parameters

sub

required

string

The sub is specified when fetching payment details.

header Parameters

Authorization required	string Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni... The access token is a base64-encoded string that is required for all API calls. It is a JWT (JSON Web Token). The access token is fetched from `POST:/accesstoken/get`. It is valid for 1 hour in the test environment and 24 hours in the production environment.
Ocp-Apim-Subscription-Key required	string Example: 0f14ebcab0ec4b29ae0cb90d91b4a84a The subscription key for your API product is available on portal.vipps.no, under the 'Utvikler' tab. Keep it secret.
Merchant-Serial-Number	string Example: 123456 The Merchant Serial Number (MSN) is a unique id for the sales unit for which this payment is made. This is a required parameter if you are a Vipps Recurring partner making payments on behalf of a merchant. The partner must use the merchant's MSN (not the partner's MSN). This parameter is optional, and recommended, for regular Vipps merchants making payments for themselves.
Vipps-System-Name	string <= 30 characters Example: WooCommerce The name of the ecommerce solution. One word in lowercase letters is good. See http-headers.
Vipps-System-Version	string <= 30 characters Example: 5.4.0 The version number of the ecommerce solution. See http-headers.
Vipps-System-Plugin-Name	string <= 30 characters Example: woocommerce-payment The name of the ecommerce plugin (if applicable). One word in lowercase letters is good. See http-headers.
Vipps-System-Plugin-Version	string <= 30 characters Example: 1.2.1 The version number of the ecommerce plugin (if applicable). See http-headers.

Responses

Response samples

Content type

application/json;charset=UTF-8

{"accounts": [{"account_name": "Savings account",
"account_number": 86011117947,
"bank_name": "ACME Bank"
}
],
"address": {"address_type": "home",
"country": "NO",
"default": true,
"formatted": "Robert Levins gate 5\n0154 Oslo",
"postal_code": "0154",
"region": "Oslo",
"street_address": "Robert Levins gate 5"
},
"other_addresses": [{"address_type": "home",
"country": "NO",
"default": true,
"formatted": "Robert Levins gate 5\n0154 Oslo",
"postal_code": "0154",
"region": "Oslo",
"street_address": "Robert Levins gate 5"
}
],
"birthdate": "2000-12-31",
"email": "user@example.com",
"email_verified": true,
"family_name": "Lovelace",
"given_name": "Ada",
"name": "Ada Lovelace",
"nin": "09057517287",
"phone_number": "4791234567",
"sid": "7d78a726-af92-499e-b857-de263ef9a969",
"sub": "c06c4afe-d9e1-4c5d-939a-177d752a0944"
}

Get Userinfo in the Login API flow

This endpoint is only for use in the Login API in browser flow. It returns the payload with the information that the user has consented to share. Find more info on the /userinfo endpoint at the OIDC Standard.

header Parameters

Authorization required	string Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni... The access token is a base64-encoded string that is required for all API calls. It is a JWT (JSON Web Token). The access token is fetched from `POST:/accesstoken/get`. It is valid for 1 hour in the test environment and 24 hours in the production environment.
Ocp-Apim-Subscription-Key required	string Example: 0f14ebcab0ec4b29ae0cb90d91b4a84a The subscription key for your API product is available on portal.vipps.no, under the 'Utvikler' tab. Keep it secret.
Merchant-Serial-Number	string Example: 123456 The Merchant Serial Number (MSN) is a unique id for the sales unit for which this payment is made. This is a required parameter if you are a Vipps Recurring partner making payments on behalf of a merchant. The partner must use the merchant's MSN (not the partner's MSN). This parameter is optional, and recommended, for regular Vipps merchants making payments for themselves.
Vipps-System-Name	string <= 30 characters Example: WooCommerce The name of the ecommerce solution. One word in lowercase letters is good. See http-headers.
Vipps-System-Version	string <= 30 characters Example: 5.4.0 The version number of the ecommerce solution. See http-headers.
Vipps-System-Plugin-Name	string <= 30 characters Example: woocommerce-payment The name of the ecommerce plugin (if applicable). One word in lowercase letters is good. See http-headers.
Vipps-System-Plugin-Version	string <= 30 characters Example: 1.2.1 The version number of the ecommerce plugin (if applicable). See http-headers.

Responses

Response samples

Content type

application/json;charset=UTF-8

{"accounts": [{"account_name": "Savings account",
"account_number": 86011117947,
"bank_name": "ACME Bank"
}
],
"address": {"address_type": "home",
"country": "NO",
"default": true,
"formatted": "Robert Levins gate 5\n0154 Oslo",
"postal_code": "0154",
"region": "Oslo",
"street_address": "Robert Levins gate 5"
},
"other_addresses": [{"address_type": "home",
"country": "NO",
"default": true,
"formatted": "Robert Levins gate 5\n0154 Oslo",
"postal_code": "0154",
"region": "Oslo",
"street_address": "Robert Levins gate 5"
}
],
"birthdate": "2000-12-31",
"email": "user@example.com",
"email_verified": true,
"family_name": "Lovelace",
"given_name": "Ada",
"name": "Ada Lovelace",
"nin": "09057517287",
"phone_number": "4791234567",
"sid": "7d78a726-af92-499e-b857-de263ef9a969",
"sub": "c06c4afe-d9e1-4c5d-939a-177d752a0944"
}