Skip to main content

Profile sharing

View as Markdown (opens in a new tab)
Install AI tools

Give your assistant up-to-date guidance for our APIs, with our plugin or without it.

The plugin is still under development. See the AI tools page for details.

Run both commands, in order.

claude plugin marketplace add vippsas/agent-toolkit
claude plugin install vipps-developer@agent-toolkit

For troubleshooting, see the full instructions.

The Recurring API enables merchants to request the user's profile information (such as phone number or email address) as part of the payment agreement sign up flow. We call this the Profile sharing flow. It is also referred to as the user info flow.

Privacy terms

Ensure that you comply with our privacy terms.

Example industries/use-cases​

✨ Any merchant who wants to provide a smoother subscription sign up experience for their users.

How it looks in the app​

Vipps user information consent

Screenshot: Three-screen profile sharing and payment agreement sign-up flow in the app (Vipps or MobilePay) — the consent step shows a "Give access" screen listing profile fields (name, email, phone number, address, birth date) with an "I accept" button; the overview step shows the agreement with a campaign discount callout; the approval step shows a "Confirm payment method" prompt with a payment card and a Pay/Confirm button.

API request snippet​

{
  "pricing": {
    "type": "LEGACY",
    "amount": 2500,
    "currency": "NOK"
  },
  "interval": {
    "unit": "MONTH",
    "count": 1
  },
  "merchantRedirectUrl": "https://example.com/redirect",
  "merchantAgreementUrl": "https://example.com/agreement",
  "phoneNumber": "4712345678",
  "productName": "MyNews Digital",
  "scope": "address name email birthDate phoneNumber"
}

Include the scope values you need access to (e.g., "address email name phoneNumber"), separated by spaces. The options include: address, birthDate, email, name, phoneNumber, and nin (in special cases). See Userinfo API guide: scope for more details.

Tip

Use as few scopes as possible to reduce the risk that the user cancels the agreement request.

For more details, see the Userinfo API guide.

Last updated on