Intergiro developer portal

# Introduction

Individuals represent end users and it's important to have them properly registered before they can use accounts or cards. This process is called onboarding.

IMPORTANT

Pending actions feature is mandatory for Cards / Onboarding as a Service API implementation. This part is integral, as specific API functionalities and operational processes are dependent on the successful integration of the Pending Actions feature. For in-depth insights and integration guidelines, refer to our Pending Actions (opens new window) article.

# Create individual

The first step is to provide some basic personal information about an individual.

Example create individual request:

 



















POST /v3/individuals

Content-Type: application/json
Authorization: Bearer <access_token>

{
  "first_name": "John",
  "last_name": "de Mayor",
  "email": "m6dreey@goes.es",
  "phone_number": "46627211111",
  "date_of_birth": "1991-12-06",
  "address": {
  	"country_code": "SE",
  	"street1": "Mälarö torg 2",
  	"city": "Ekerö",
  	"region": "Ekerö",
  	"postal_code": "178 30"
  }
}

Address is optional.

Once created, you can query an individual by calling GET /v3/individuals/:id.

# Initiate onboarding

Our API provides a flexible way to initiate the user onboarding process, whether through a web browser or directly within your mobile application using our Mobile SDKs. Upon successful initiation via the API, you will receive a redirect_url and a token in the response, enabling these two distinct approaches.

# Approach 1: Starting the Onboarding Flow via Web

This approach is ideal for web applications, when you want to leverage a browser-based experience for the onboarding process.

# How it works

The redirect_url provided in the API response is a pre-signed URL that, when accessed, will automatically start the onboarding flow in the user's browser. The necessary token is already embedded within this URL.

# Implementation

Call the POST /individuals/:id/onboard endpoint to initiate individual onboarding and to get the redirect_url:

 





 


POST /v3/individuals/9c017aec-c952-4713-aa10-11708cb0d11a/onboard

Content-Type: application/json
Authorization: Bearer <access_token>

{
  "return_url": "https://example.com/onboarding_callback"
}

Response:

 


 




HTTP 200 OK

{
  "redirect_url": "https://integrate.intergiro.com/onboarding/...",
  "expires_at": "2025-06-08T14:09:15.000Z",
  "token": "eyJjbGFpbXMiOnt9LCJwZXJtaX"
}

Now you need to perform a client-side redirect to the redirect_url.

REQUIREMENT

To ensure the best user experience (UX), along with stable operation of the onboarding flow and biometric functions, we require the following:

  1. Native Applications:
  1. Web Applications:
  • Use a standalone browser for redirect experiences.
  • Customer Support Note: While we recommend using a standalone browser, it is not possible to control the browser users choose to open the app. As not all browsers are supported by our * providers in case of a user support request, please ensure the browser the user is using is supported (opens new window) by one of our providers.

Please note that we do not guarantee support for redirect flows integrated into your application in any manner other than those mentioned above.

Once initiated, wait for IndividualOnboardingDataProvided webhook event that will be delivered as soon as the user successfully completes the form. That will mean the ball is on Intergiro side as we'll be receiving the data for approval.

# Approach 2: Starting the Onboarding Flow via Mobile SDK

This approach is recommended for a native, fully integrated experience for your mobile users, leveraging the full capabilities of our Mobile SDKs.

# How it works:

The token provided in the API response is used to initialize our mobile SDK, which then takes over the UI and flow for the onboarding process directly within your mobile application.

# Implementation

For more detailed implementation guides specific to the Onboarding Flow via Mobile SDKs, refer to the dedicated Mobile SDKs Onboarding section below.

← Onboarding events →