Bank Verification Token

To learn more about bank verification functionality, check our help center guide on Bank Verification.

Bank Verification API Integration

Generating a Bank Verification Token

Token Generation API Endpoint

Method: POST
Endpoint: https://ivs.idenfy.com/bank/tokens/

There are no required parameters for token generation.

Parameter	Sub-parameter	Description	Default
lifetime		The duration in seconds of the token's validity.	3600
country		The user's bank country (ISO alpha-2 code).	null
bank		The user's bank name.	null
access		Defines the data to be retrieved from the bank.	object
	accounts	Retrieve all accounts held by the user.	false
	balances	Retrieve account balances.	false
	transactions	Retrieve a list of transactions for each account.	false

Example Request

{
  "lifetime": 3600,
  "country": "LT",
  "bank": "Swedbank",
  "access": {
    "accounts": true,
    "balances": true,
    "transactions": true
  }
}

Example Response

{
  "tokenString": "LVS8YgSTTVuXAHiur10yCabIAWLizUlXjh40tCtg",
  "expiration": "2025-03-06T10:39:08.092153Z",
  "isValid": true,
  "country": "LT",
  "bank": "Swedbank",
  "access": {
    "accounts": true,
    "balances": true,
    "transactions": true
  }
}

info

Appended generated tokenString with the link https://bank-verification.ui.idenfy.com/?token= to provide to end-user.

URL: https://bank-verification.ui.idenfy.com/?token=LVS8YgSTTVuXAHiur10yCabIAWLizUlX

Webhook Response

Once the end-user completes Bank Verification, you will receive a webhook notification with the response.

Example Webhook Response

{
  "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "country": "LT",
  "bank": "Swedbank",
  "accounts": [
    {
      "id": "11112222-3333-4444-5555-666677778888",
      "name": "Savings Account",
      "iban": "LT127300010012345678",
      "currency": "EUR",
      "balancesOverview": {
        "bookedBalance": 1250.75,
        "availableBalance": 1300.75
      },
      "transactionsCount": 35
    },
    {
      "id": "99990000-aaaa-bbbb-cccc-dddd11112222",
      "name": "Checking Account",
      "iban": "LT987300010087654321",
      "currency": "EUR",
      "balancesOverview": {
        "bookedBalance": 350.20,
        "availableBalance": 400.20
      },
      "transactionsCount": 60
    },
    {
       "id": "eeeeffff-1111-2222-3333-444455556666",
       "name": "Business Account",
       "iban": "LT567300010011223344",
       "currency": "EUR",
       "balancesOverview": {
         "bookedBalance": 15000.50,
         "availableBalance": 15500.50
       },
       "transactionsCount": 120
    },
    {
      "id": "abcdef01-2345-6789-0abc-def012345678",
      "name": "Investment Account",
      "iban": "LT247300010098765432",
      "currency": "EUR",
      "balancesOverview": {
        "bookedBalance": 50000.00,
        "availableBalance": 50000.00
      },
      "transactionsCount": 10
    },
     {
      "id": "12345678-90ab-cdef-1234-567890abcdef",
      "name": "Travel Account",
      "iban": "LT877300010022334455",
      "currency": "EUR",
      "balancesOverview": {
        "bookedBalance": 750.80,
        "availableBalance": 800.80
      },
      "transactionsCount": 25
    }

  ],
  "riskLevel": "MEDIUM"
}

Listing Account Transactions

Retrieving Account Transactions

Method: GET
Endpoint: https://ivs.idenfy.com/bank/verifications/{verificationId}/accounts/{accountId}/transactions/

Path Parameters

Parameter	Description	Required	Type
verificationId	The ID of the verification.	Yes	string
accountId	The ID of the account.	Yes	string

Query Parameters

Parameter	Description	Required	Type
page	The page number in the paginated result set.	No	integer
perPage	The number of results per page.	No	integer

Example Response

{
  "count": 123,
  "next": "https://ivs.idenfy.com/bank/verifications/{verificationId}/accounts/?page=4",
  "previous": "https://ivs.idenfy.com/bank/verifications/{verificationId}/accounts/?page=2",
  "results": [
    {
      "creditor": {
        "fullName": "John Doe"
      },
      "debtor": {
        "fullName": "Jane Smith"
      },
      "bookingDate": "2024-03-06",
      "transactionDate": "2024-03-06",
      "transactionAmount": {
        "amount": "100.00",
        "currency": "EUR"
      }
    }
  ]
}