Aggregation

When aggregation is enabled in your account, Zūm Rails can pull a user’s financial data. This applies for use-cases such as account verification (Know Your Customer - KYC) and risk assessment (Based on past transaction history).

Method: GET

Endpoint: {{env}}/api/aggregation/GetInformationByRequestId/<request-id>

Response (Canada)

{
  "statusCode": 200,
  "message": "GET Request successful.",
  "isError": false,
  "result": {
    "RequestId": "6082136a-...-e4b5129dc9d4",
    "CustomerId": "b0db65fd-...-55a57b9a7c69",
    "Card": {
      "Id": "0f980576-..-02d090f70edf",
      "UpdatedAt": "0001-01-01T00:00:00Z",
      "CreatedAt": "0001-01-01T00:00:00Z",
      "Accounts": [
        {
          "Id": "dc8b5922-...-ac7e9f7eeed3",
          "UpdatedAt": "0001-01-01T00:00:00Z",
          "InstitutionNumber": "001",
          "TransitNumber": "12345",
          "AccountNumber": "1234567",
          "Title": "Bank Chequing Account",
          "Balance": 10.83,
          "Currency": "CAD",
          "AccountCategory": "Operation",
          "AccountSubCategory": "Chequing",
          "Transactions": [
            {
              "Id": "1a97486e-...-b5df75a75501",
              "UpdatedAt": "0001-01-01T00:00:00Z",
              "Date": "2022-06-05T00:00:00Z",
              "Description": "UBER EATS",
              "Debit": 30.0,
              "Balance": 1000.83,
              "Category": {
                  "Id": "baeda044-...-ae6ed78cf524",
                  "Name": "Food Delivery & Restaurants",
                  "InsightsType": "Expense"
              }
            }
          ]
        },
        {
          "Id": "bae5010d-...-5eb2f2517652",
          "UpdatedAt": "0001-01-01T00:00:00Z",
          "InstitutionNumber": "001",
          "TransitNumber": "12345",
          "AccountNumber": "1234567",
          "Title": "Bank Savings Account",
          "Balance": 103.17,
          "Currency": "CAD",
          "AccountCategory": "Operation",
          "AccountSubCategory": "Savings",
          "Transactions": [
            {
              "Id": "7bb694d3-...-df90dbc9d8ad",
              "UpdatedAt": "0001-01-01T00:00:00Z",
              "Date": "2022-06-03T00:00:00Z",
              "Description": "Bank Mortgage",
              "Debit": 530.12,
              "Balance": 103.17,
              "Category": {
                  "Id": "baeda044-...-ae6ed78cf524",
                  "Name": "Mortgage payments",
                  "InsightsType": "Expense"
              }
            }
          ]
        },
        {
          "Id": "4ff87b60-...-28b40cb1d935",
          "UpdatedAt": "0001-01-01T00:00:00Z",
          "InstitutionNumber": "001",
          "TransitNumber": "00152",
          "AccountNumber": "4242 xxxx  xxxx 4242",
          "Title": "Bank World Visa",
          "Balance": 3953.75,
          "Currency": "CAD",
          "AccountCategory": "Credit",
          "AccountSubCategory": "CreditCard",
          "Transactions": [
            {
              "Id": "e7523aa5-....-790bfa70ee9b",
              "UpdatedAt": "0001-01-01T00:00:00Z",
              "Date": "2022-06-04T00:00:00Z",
              "Description": "TARGET STORE",
              "Debit": 29.35,
              "Balance": 548.78,
              "Category": {
                  "Id": "baeda044-...-ae6ed78cf524",
                  "Name": "Other Shopping",
                  "InsightsType": "Expense"
              }
            }
          ]
        }
      ],
      "InstitutionId": "08cde436-e9a0-41c3-915a-7e7ebad26be8",
      "InstitutionName": "Tangerine",
      "HolderId": "634ba946-...-2815891e3439",
      "Holder": {
        "FirstName": "John Paul",
        "LastName": "Smith",
        "FullName": "John Paul Smith",
        "Email": "[e-mail]",
        "PhoneNumber": "514-123-1234",
        "DateOfBirth": "1980-01-01",
        "AddressCivic": "101 Street",
        "AddressCity": "Toronto",
        "AddressProvince": "ON",
        "AddressCountry": "CA",
        "AddressPostalCode": "A0A 0A0"
      },
      "SelectedAccountId": "dc8b5922-...-ac7e9f7eeed3"
    }
  }
}{
  "statusCode": 200,
  "message": "GET Request successful.",
  "isError": false,
  "result": {
    "RequestId": "6082136a-...-e4b5129dc9d4",
    "CustomerId": "b0db65fd-...-55a57b9a7c69",
    "Card": {
      "Id": "0f980576-..-02d090f70edf",
      "UpdatedAt": "0001-01-01T00:00:00Z",
      "CreatedAt": "0001-01-01T00:00:00Z",
      "Accounts": [
        {
          "Id": "dc8b5922-...-ac7e9f7eeed3",
          "UpdatedAt": "0001-01-01T00:00:00Z",
          "InstitutionNumber": "001",
          "TransitNumber": "12345",
          "AccountNumber": "1234567",
          "Title": "Bank Chequing Account",
          "Balance": 10.83,
          "Currency": "CAD",
          "AccountCategory": "Operation",
          "AccountSubCategory": "Chequing",
          "Transactions": [
            {
              "Id": "1a97486e-...-b5df75a75501",
              "UpdatedAt": "0001-01-01T00:00:00Z",
              "Date": "2022-06-05T00:00:00Z",
              "Description": "UBER EATS",
              "Debit": 30.0,
              "Balance": 1000.83,
              "Category": {
                  "Id": "baeda044-...-ae6ed78cf524",
                  "Name": "Food Delivery & Restaurants",
                  "InsightsType": "Expense"
              }
            }
          ]
        },
        {
          "Id": "bae5010d-...-5eb2f2517652",
          "UpdatedAt": "0001-01-01T00:00:00Z",
          "InstitutionNumber": "001",
          "TransitNumber": "12345",
          "AccountNumber": "1234567",
          "Title": "Bank Savings Account",
          "Balance": 103.17,
          "Currency": "CAD",
          "AccountCategory": "Operation",
          "AccountSubCategory": "Savings",
          "Transactions": [
            {
              "Id": "7bb694d3-...-df90dbc9d8ad",
              "UpdatedAt": "0001-01-01T00:00:00Z",
              "Date": "2022-06-03T00:00:00Z",
              "Description": "Bank Mortgage",
              "Debit": 530.12,
              "Balance": 103.17,
              "Category": {
                  "Id": "baeda044-...-ae6ed78cf524",
                  "Name": "Mortgage payments",
                  "InsightsType": "Expense"
              }
            }
          ]
        },
        {
          "Id": "4ff87b60-...-28b40cb1d935",
          "UpdatedAt": "0001-01-01T00:00:00Z",
          "InstitutionNumber": "001",
          "TransitNumber": "00152",
          "AccountNumber": "4242 xxxx  xxxx 4242",
          "Title": "Bank World Visa",
          "Balance": 3953.75,
          "Currency": "CAD",
          "AccountCategory": "Credit",
          "AccountSubCategory": "CreditCard",
          "Transactions": [
            {
              "Id": "e7523aa5-....-790bfa70ee9b",
              "UpdatedAt": "0001-01-01T00:00:00Z",
              "Date": "2022-06-04T00:00:00Z",
              "Description": "TARGET STORE",
              "Debit": 29.35,
              "Balance": 548.78,
              "Category": {
                  "Id": "baeda044-...-ae6ed78cf524",
                  "Name": "Other Shopping",
                  "InsightsType": "Expense"
              }
            }
          ]
        }
      ],
      "InstitutionId": "08cde436-e9a0-41c3-915a-7e7ebad26be8",
      "InstitutionName": "Tangerine",
      "HolderId": "634ba946-...-2815891e3439",
      "Holder": {
        "FirstName": "John Paul",
        "LastName": "Smith",
        "FullName": "John Paul Smith",
        "Email": "[e-mail]",
        "PhoneNumber": "514-123-1234",
        "DateOfBirth": "1980-01-01",
        "AddressCivic": "101 Street",
        "AddressCity": "Toronto",
        "AddressProvince": "ON",
        "AddressCountry": "CA",
        "AddressPostalCode": "A0A 0A0"
      },
      "SelectedAccountId": "dc8b5922-...-ac7e9f7eeed3"
    }
  }
}

Response (US)

{
  "statusCode": 200,
  "message": "GET Request successful.",
  "isError": false,
  "result": {
    "RequestId": "6082136a-...-e4b5129dc9d4",
    "CustomerId": "b0db65fd-...-55a57b9a7c69",
    "Card": {
      "Id": "0f980576-..-02d090f70edf",
      "UpdatedAt": "0001-01-01T00:00:00Z",
      "CreatedAt": "0001-01-01T00:00:00Z",
      "Accounts": [
        {
          "Id": "dc8b5922-...-ac7e9f7eeed3",
          "AccountNumber": "876022383",
          "RoutingNumber": "021000021",
          "Title": "Bank Chequing Account",
          "Balance": 10.83,
          "Currency": "USD",
          "AccountCategory": "Operation",
          "AccountSubCategory": "Chequing",
          "Transactions": [
            {
              "Id": "1a97486e-...-b5df75a75501",
              "UpdatedAt": "0001-01-01T00:00:00Z",
              "Date": "2022-06-05T00:00:00Z",
              "Description": "UBER EATS",
              "Debit": 30.0,
              "Balance": 1000.83,
              "Category": {
                  "Id": "baeda044-...-ae6ed78cf524",
                  "Name": "Food Delivery & Restaurants",
                  "InsightsType": "Expense"
              }
            }
          ]
        },
        {
          "Id": "bae5010d-...-5eb2f2517652",
          "AccountNumber": "4242424242424242",
          "RoutingNumber": "021000021",
          "Title": "Bank Savings Account",
          "Balance": 103.17,
          "Currency": "USD",
          "AccountCategory": "Operation",
          "AccountSubCategory": "Savings",
          "Transactions": [
            {
              "Id": "7bb694d3-...-df90dbc9d8ad",
              "UpdatedAt": "0001-01-01T00:00:00Z",
              "Date": "2022-06-03T00:00:00Z",
              "Description": "Bank Mortgage",
              "Debit": 530.12,
              "Balance": 103.17,
              "Category": {
                  "Id": "baeda044-...-ae6ed78cf524",
                  "Name": "Mortgage payments",
                  "InsightsType": "Expense"
              }
            }
          ]
        },
        {
          "Id": "4ff87b60-...-28b40cb1d935",
          "AccountNumber": "4242424242424242",
          "RoutingNumber": "021000021",
          "Title": "Bank World Visa",
          "Balance": 3953.75,
          "Currency": "USD",
          "AccountCategory": "Credit",
          "AccountSubCategory": "CreditCard",
          "Transactions": [
            {
              "Id": "e7523aa5-....-790bfa70ee9b",
              "UpdatedAt": "0001-01-01T00:00:00Z",
              "Date": "2022-06-04T00:00:00Z",
              "Description": "TARGET STORE",
              "Debit": 29.35,
              "Balance": 548.78,
              "Category": {
                  "Id": "baeda044-...-ae6ed78cf524",
                  "Name": "Other Shopping",
                  "InsightsType": "Expense"
              }
            }
          ]
        }
      ],
      "InstitutionId": "08cde436-e9a0-41c3-915a-7e7ebad26be8",
      "InstitutionName": "Zūm Rails Testing Bank",
      "HolderId": "634ba946-...-2815891e3439",
      "Holder": {
        "FirstName": "John",
        "LastName": "Doe",
        "FullName": "John Doe",
        "Email": "[e-mail]",
        "PhoneNumber": "999 999 9999",
        "DateOfBirth": "01-01-1990",
        "AddressCivic": "1st Street",
        "AddressCity": "New York",
        "AddressProvince": "New York",
        "AddressCountry": "US",
        "AddressPostalCode": "111111111"
      },
      "SelectedAccountId": "dc8b5922-...-ac7e9f7eeed3"
    }
  }
}

Response

Canada

Parameter	Type	Description
id	guid	User id
RequestId	string	The id of the request
CustomerId	string	Your customer id
Card
Id	guid	Card Id
UpdatedAt	datetime	When the card was last updated
CreatedAt	datetime	When the card was originally created
InstitutionName	string	The name of the institution
SelectedAccountId	guid	The selected account id in the Connector. This is the account to be used for EFT payments
Accounts	list
Id	guid	The account id
InstitutionNumber	string	The institutioin number (used for EFT)
TransitNumber	string	The transit number (used for EFT)
AccountNumber	string	The account number (used for EFT)
Title	string	The account title
Balance	decimal	The account balance
Currency	string	The account currency, CAD, USD or OTHER
AccountCategory	string	The account category
AccountSubCategory	string	The account subcategory
Transactions	list
Id	guid	The transaction id
Date	datetime	Date when the transaction happened
Description	string	Transaction description
Debit	decimal	Amount when the transaction is debit
Credit	decimal	Amount when the transaction is credit
Balance	decimal	Balance of the account at the moment of the transaction
Category	list
Id	guid	The category id
Name	string	The name of the category
InsightsType	string	Indicate if it's income or expense
Holder
FirstName	string	Account holder first name
LastName	string	Account holder last name
FullName	string	Account holder full name
Email	string	Account holder email
PhoneNumber	string	Account holder phone number
DateOfBirth	string	Account holder date of birth
AddressCivic	string	Account holder address
AddressCity	string	Account holder address city
AddressProvince	string	Account holder address province
AddressCountry	string	Account holder address country
AddressPostalCode	string	Account holder address postal code

US

Parameter	Type	Description
RequestId	string	The id of the request
CustomerId	string	Your customer id
Card
Id	guid	Card Id
UpdatedAt	datetime	When the card was last updated
CreatedAt	datetime	When the card was originally created
InstitutionId	guid	Institution Id
InstitutionName	string	The name of the institution
HolderId	guid	Holder Id
SelectedAccountId	guid	The selected account id in the Connector. This is the account to be used for ACH payments
Accounts	list
Id	guid	The account id
AccountNumber	string	The account number (used for ACH)
RoutingNumber	string	The account routing number (used for ACH)
Title	string	The account title
Balance	decimal	The account balance
Currency	string	The account currency USD
AccountCategory	string	The account category
AccountSubCategory	string	The account subcategory
Transactions	list
Id	guid	The transaction id
Date	datetime	Date when the transaction happened
Description	string	Transaction description
Debit	decimal	Amount when the transaction is debit
Credit	decimal	Amount when the transaction is credit
Balance	decimal	Balance of the account at the moment of the transaction (if available)
Category	list
Id	guid	The category id
Name	string	The name of the category
InsightsType	string	Indicate if it's income or expense
Holder
FirstName	string	Account holder first name
LastName	string	Account holder last name
FullName	string	Account holder full name
Email	string	Account holder email
PhoneNumber	string	Account holder phone number
DateOfBirth	string	Account holder date of birth
AddressCivic	string	Account holder address
AddressCity	string	Account holder address city
AddressProvince	string	Account holder address province
AddressCountry	string	Account holder address country
AddressPostalCode	string	Account holder address postal code

Account Category

Canada

Type	Description
Operation	Accounts that could be used for day-to-day use, such as EFT, or Savings
Product	Accounts that are sold as a product by the institution, such as investments accounts
Credit	Credit Cards
Other	Any other type of account

US

Type	Description
Operation	Accounts that could be used for day-to-day use, such as ACH, or Savings
Product	Accounts that are sold as a product by the institution, such as investments accounts
Credit	Credit Cards
Other	Any other type of account

Account Sub Category

Type	Category	Description
Chequing	Operation	Checkings account
Savings	Operation	Savings account
CreditCard	Credit	Credit card accounts
CreditCardPrepaid	Credit	Pre-paid cards
GIC	Product	GIC accounts
LineOfCredit	Product	Any line of credit account
LoanStudent	Product	Student loans accounts
RRSP	Product	RRSP accounts
Loan	Product	Any other loan account
GIC	Product	GIC accounts
TFSA	Product	TFSA accounts
Mortgage	Product	Mortgage accounts