Introduction

Core Products

Using the Ivy API, you can verify the identity of your customers and match identification data such as bank account numbers and account holders' names without touching sensitive data or checking their balances.

This is useful for KYC and AML checks, as well as for fraud prevention. The API is designed to be as simple as possible so you can integrate it into your existing systems with minimal effort.

In general, accessing the Bank Data involves three steps:

Create a Data Session for the user with an API request. The request contains the type of permission you want to request from the user and the URLs to which the user will be redirected after the session is completed.
Redirect the user to the URL returned in the response. The user will be asked to give the requested permissions with their Bank Login and will return to the success or error URL you asked for in the request. The URL will have ?referene=<referenceId> and &data-id=<dataSessionId> of the data session as query parameters.
The result is sent as a webhook of type data_session_completed to the resultCallbackUrl you specified in the request. The result will contain the data you requested. You can check the Signature to verify that the result comes from Ivy (see Verify Signature).

The Ivy API currently supports the following use cases:

Verify Identity allows you to retrieve a user's full name, birth date, and IBAN.
Match Identity Data allows you to match the full name and bank account number against your data.

Recurring Users

Ivy enables you to make the user experience as smooth as possible by allowing you to create and add external user data to a Data Session. This way, the user does not have to authenticate with their bank again, but you can request any past data from the user.

Web Integration

Loading the Ivy Web Integration in an iframe on your website is possible. This way, the user does not have to leave your website to authenticate with their bank.

Test Flows

You can test your integration with fake data.