Get login identity

curl --request GET \
  --url https://api.prod.finverse.net/login_identity \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.prod.finverse.net/login_identity', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.prod.finverse.net/login_identity",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prod.finverse.net/login_identity"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.prod.finverse.net/login_identity")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "institution": {
    "countries": [
      "HKG",
      "SGP",
      "PHL"
    ],
    "institution_id": "testbank",
    "institution_name": "TestBank HK",
    "portal_name": "Test Bank Personal Account"
  },
  "login_identity": {
    "authentication_id": "0",
    "authentication_status": {
      "last_successful_update": "2021-12-03T02:08:23.087Z",
      "last_update": "2021-12-03T02:08:23.087Z",
      "status": "AUTHENTICATED",
      "status_details": "AUTHENTICATED"
    },
    "billing_details": {
      "billed_products": null
    },
    "created_at": "2021-12-03T02:07:58.103Z",
    "customer_app_id": "{{customer_app_id}}",
    "error": {},
    "first_success": "2021-12-03T02:07:58.103Z",
    "institution_id": "testbank",
    "last_session_id": "01FZDHPQ5NZSMBEZ2RB6J5PQC3",
    "last_success": "2021-12-03T02:08:23.034Z",
    "linking_attempt_id": "0",
    "login_identity_id": "01FNZ0RP2MWD0SNFBXT8VJ65PE",
    "login_methods_available": {},
    "permissions": null,
    "permissions_expiry_date": "2021-12-03T02:07:58.103Z",
    "permissions_grant_date": "2021-12-03T02:07:58.103Z",
    "product_status": {
      "account_numbers": {
        "last_successful_update": "2021-12-03T02:08:25.189Z",
        "last_update": "2021-12-03T02:08:25.189Z",
        "status": "SUCCESS",
        "status_details": "ACCOUNT_NUMBERS_RETRIEVED"
      },
      "accounts": {
        "last_successful_update": "2021-12-03T02:08:25.050Z",
        "last_update": "2021-12-03T02:08:25.050Z",
        "status": "SUCCESS",
        "status_details": "ACCOUNTS_RETRIEVED"
      },
      "balance_history": {
        "status": "SUCCESS",
        "status_details": "BALANCE_HISTORY_RETRIEVED"
      },
      "historical_transactions": {
        "last_update": "2021-12-03T02:08:33.698Z",
        "status": "SUCCESS",
        "status_details": "HISTORICAL_TRANSACTIONS_RETRIEVED"
      },
      "identity": {
        "last_successful_update": "2021-12-03T02:08:27.898Z",
        "last_update": "2021-12-03T02:08:27.898Z",
        "status": "SUCCESS",
        "status_details": "IDENTITY_RETRIEVED"
      },
      "online_transactions": {
        "last_successful_update": "2021-12-03T02:08:26.790Z",
        "last_update": "2021-12-03T02:08:26.790Z",
        "status": "SUCCESS",
        "status_details": "ONLINE_TRANSACTIONS_RETRIEVED"
      },
      "statements": {
        "last_successful_update": "2021-12-03T02:08:29.092Z",
        "last_update": "2021-12-03T02:08:29.092Z",
        "status": "SUCCESS",
        "status_details": "STATEMENTS_RETRIEVED"
      }
    },
    "refresh": {
      "credentials_stored": true,
      "refresh_allowed": true
    },
    "session_status": "COMPLETED",
    "status": "DATA_RETRIEVAL_COMPLETE",
    "status_details": {
      "event_date": "2021-12-03T02:08:33.794Z",
      "event_name": "BALANCE_HISTORY_RETRIEVED"
    },
    "updated_at": "2021-12-03T02:08:33.811Z",
    "user_id": "01FN8TJ92X38QF7B4N5HRP8X3K",
    "webhook": "https://example.com/callback"
  }
}

Get login identity

Retrieve information about a Login Identity, including its authentication and data retrieval status. Does not contain any sensitive user data.

Note: a Login Identity represents a unique financial institution authenticated account linked by the end-user. An end-user who links multiple Institutions (or multiple authenticated accounts at the same Institution), will have a distinct Login Identity for each linked account.

Authorization: login_identity_token

institution

Summary Institutions object. See GET /institutions for object details.

login_identity

Full login_identity object, containing metadata and status information.

authentication_status

Provides details on the authentication status of the Login Identity.

error

Provides additional details on any error. Empty if no error has occurred.

product_status

Provides details on the data retrieval status of the Login Identity, broken down by Finverse Products.

We recommend using this field to determine when to fetch data from Finverse’s product endpoints (if not using webhooks).

Products: accounts, account_numbers, balance_history, historical_transactions, identity, income_estimation,online_transactions, statements.

Note: Requesting GET /transactions fetches both online_transactions and historical_transactions (if available). Online transactions refer to transaction records retrieved directly from the institution (sometimes covering only a limited time-period); historical transactions refer to additional records which Finverse extracts from statements.

product_status contains a list of Products, each returning the following status object. Each Product will only be listed once data retrieval has started for the Product.

Refresh

Provides details on the ability to refresh data for a Login Identity (i.e. retrieve new data from the institution without any additional user action). Will only be returned if user consented to automated data refreshes.

Refer to section 12 - Data Refresh & Relinking for additional guidance on refresh & relinking.

status_details

Provides details on the most recent event involving this Login Identity (e.g. authentication, data retrieval, unlinking). See GET /login_identity/{login_identity_id}/history to request the full events list involving a Login Identity.

GET

login_identity

Get login identity

curl --request GET \
  --url https://api.prod.finverse.net/login_identity \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.prod.finverse.net/login_identity', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.prod.finverse.net/login_identity",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prod.finverse.net/login_identity"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.prod.finverse.net/login_identity")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "institution": {
    "countries": [
      "HKG",
      "SGP",
      "PHL"
    ],
    "institution_id": "testbank",
    "institution_name": "TestBank HK",
    "portal_name": "Test Bank Personal Account"
  },
  "login_identity": {
    "authentication_id": "0",
    "authentication_status": {
      "last_successful_update": "2021-12-03T02:08:23.087Z",
      "last_update": "2021-12-03T02:08:23.087Z",
      "status": "AUTHENTICATED",
      "status_details": "AUTHENTICATED"
    },
    "billing_details": {
      "billed_products": null
    },
    "created_at": "2021-12-03T02:07:58.103Z",
    "customer_app_id": "{{customer_app_id}}",
    "error": {},
    "first_success": "2021-12-03T02:07:58.103Z",
    "institution_id": "testbank",
    "last_session_id": "01FZDHPQ5NZSMBEZ2RB6J5PQC3",
    "last_success": "2021-12-03T02:08:23.034Z",
    "linking_attempt_id": "0",
    "login_identity_id": "01FNZ0RP2MWD0SNFBXT8VJ65PE",
    "login_methods_available": {},
    "permissions": null,
    "permissions_expiry_date": "2021-12-03T02:07:58.103Z",
    "permissions_grant_date": "2021-12-03T02:07:58.103Z",
    "product_status": {
      "account_numbers": {
        "last_successful_update": "2021-12-03T02:08:25.189Z",
        "last_update": "2021-12-03T02:08:25.189Z",
        "status": "SUCCESS",
        "status_details": "ACCOUNT_NUMBERS_RETRIEVED"
      },
      "accounts": {
        "last_successful_update": "2021-12-03T02:08:25.050Z",
        "last_update": "2021-12-03T02:08:25.050Z",
        "status": "SUCCESS",
        "status_details": "ACCOUNTS_RETRIEVED"
      },
      "balance_history": {
        "status": "SUCCESS",
        "status_details": "BALANCE_HISTORY_RETRIEVED"
      },
      "historical_transactions": {
        "last_update": "2021-12-03T02:08:33.698Z",
        "status": "SUCCESS",
        "status_details": "HISTORICAL_TRANSACTIONS_RETRIEVED"
      },
      "identity": {
        "last_successful_update": "2021-12-03T02:08:27.898Z",
        "last_update": "2021-12-03T02:08:27.898Z",
        "status": "SUCCESS",
        "status_details": "IDENTITY_RETRIEVED"
      },
      "online_transactions": {
        "last_successful_update": "2021-12-03T02:08:26.790Z",
        "last_update": "2021-12-03T02:08:26.790Z",
        "status": "SUCCESS",
        "status_details": "ONLINE_TRANSACTIONS_RETRIEVED"
      },
      "statements": {
        "last_successful_update": "2021-12-03T02:08:29.092Z",
        "last_update": "2021-12-03T02:08:29.092Z",
        "status": "SUCCESS",
        "status_details": "STATEMENTS_RETRIEVED"
      }
    },
    "refresh": {
      "credentials_stored": true,
      "refresh_allowed": true
    },
    "session_status": "COMPLETED",
    "status": "DATA_RETRIEVAL_COMPLETE",
    "status_details": {
      "event_date": "2021-12-03T02:08:33.794Z",
      "event_name": "BALANCE_HISTORY_RETRIEVED"
    },
    "updated_at": "2021-12-03T02:08:33.811Z",
    "user_id": "01FN8TJ92X38QF7B4N5HRP8X3K",
    "webhook": "https://example.com/callback"
  }
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Response

Successful

institution

object

Show child attributes