getZimplerAccessToken

This API endpoint represents the initialization step of a Zimpler-integrated authentication, deposit, or registration flow. When your platform invokes getZimplerAccessToken, it requests a secure session from Zimpler. The response gives your frontend a hosted interface URL (user_form_url) to show the user, alongside pre-verified or cached KYC profile data if the user has a pre-existing session.

Documentation

Try it now

Request parameters:

Name	Description	Type	Values	Default

site	The specific brand, sub-domain, or site identifier configuration matching your account in Zimpler's system.	string	-	-
origin	The base URL of your frontend application. Zimpler uses this to white-label CORS headers and handle secure postMessage event communication back to your window.	string	-	-
country	The ISO country code (e.g., "SE", "FI", "DE") defining which localized banking interfaces Zimpler should load for the user.	string	-	-

This method is usually used with these methods:

confirmOnZimpler

Call example:
JavaScriptReact HookFlutter

getZimplerAccessToken({
  origin: 'https://www.betchain.net',
  country: 'SE',
  site: 'www.betchain.net'
})

Response examples:
SuccessError

{
  result: 0,
  result_text: '',
  details: {
    id: 1231,
    state: 'created',
    user_form_url: 'https://...',
    user_id: '5555',
    kyc_info: {
      pep: false,
      user_id: '5555',
      last_name: 'Smith',
      first_name: 'Will',
      address: {
        city: 'City',
        line_1: 'line 1',
        country: 'country',
        postcode: '12312',
        line_2: ''
      },
      country_code: 'ISO',
      date_of_birth: '1980-08-23',
      national_identification_number: '5556777'
    }
  }
}

Response parameters:

Name	Description	Type	Values

id	The unique internal session/tracking identifier for this Zimpler access token process on your backend.	number	-
state	The current status of the token request	string	-
user_form_url	The most critical field for the frontend. This is the secure, hosted Zimpler checkout URL. Your application must either redirect the user here or render this link inside an iframe / modal so they can log into their bank.	string	-
user_id	Your platform's unique identifier linked to this session.	string	-
kyc_info		object
└─ pep	Politically Exposed Person flag. A vital regulatory check for compliance. If true, compliance teams must manually review the user.	boolean	true / false
└─ user_id	The matching identifier connecting the KYC payload to the user session.	string	-
└─ last_name	The user's legally verified last name registered with their bank.	string	-
└─ first_name	The user's legally verified first name registered with their bank.	string	-
└─ address		object
└─ city	City of residence.	string	-
└─ line_1	Street address lines.	string	-
└─ country	Country name.	string	-
└─ postcode	Postal code / ZIP code.	string	-
└─ line_2	Street address lines.	string	-
country_code	The ISO standard representation of the user's legal nationality context.	string	-
date_of_birth	The verified birth date (YYYY-MM-DD), used to instantly confirm legal age compliance.	string	-
national_identification_number	The national ID card number or personal tax identifier code.	string	-