Download OpenAPI specification:Download
This API is used to provide profile sharing in conjunction with:
The available information includes: name
, address
, email
, phoneNumber
, and birthDate
.
Approved merchants can also request nin
.
See: Userinfo API guide
The payload contains the information that the user has consented to share.
Find more info on the /userinfo
endpoint at the OIDC Standard.
The scopes provided return the following fields:
name
- Returns family_name
, given_name
, and name
address
- Returns address
and other_addresses
email
- Returns email
and email_verified
phoneNumber
- Returns phone_number
and phone_number_verified
birthDate
- Returns birthdate
nin
- Returns nin
, if allowed. Access to the nin
requires special permission.sub required | string The |
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 |
Ocp-Apim-Subscription-Key | string Example: 0f14ebcab0ec4b29ae0cb90d91b4a84a The subscription key for your sales unit. See API keys. 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 MobilePay 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 MobilePay 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. |
{- "address": {
- "address_type": "home",
- "country": "NO",
- "formatted": "Robert Levins gate 5\n2. etg, 222\n0154 Oslo",
- "postal_code": "0154",
- "region": "Oslo",
- "street_address": "Robert Levins gate 5\n2. etg, 222"
}, - "other_addresses": [
- {
- "address_type": "home",
- "country": "NO",
- "formatted": "Robert Levins gate 5\n2. etg, 222\n0154 Oslo",
- "postal_code": "0154",
- "region": "Oslo",
- "street_address": "Robert Levins gate 5\n2. etg, 222"
}
], - "birthdate": "2000-12-31",
- "email": "user@example.com",
- "email_verified": true,
- "family_name": "Lovelace",
- "given_name": "Ada",
- "name": "Ada Lovelace",
- "nin": "09057517287",
- "phone_number": "4712345678",
- "phone_number_verified": true,
- "sid": "7d78a726-af92-499e-b857-de263ef9a969",
- "sub": "c06c4afe-d9e1-4c5d-939a-177d752a0944"
}