Profile sharing

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

MobilePay

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 they cancel the agreement request.

For more details, see the Userinfo API guide.