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).

"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": "Interac - Purchase",
"Debit": 3.0,
"Balance": 1000.83
"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": "Card Rewards Redemption",
"Credit": 33.12,
"Balance": 103.17
"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": "GROCERY STORE #12345",
"Debit": 29.35
"InstitutionId": "08cde436-e9a0-41c3-915a-7e7ebad26be8",
"InstitutionName": "Tangerine",
"HolderId": "634ba946-...-2815891e3439",
"Holder": {
"FirstName": "John Paul",
"LastName": "Smith",
"FullName": "John Paul Smith",
"Email": "",
"PhoneNumber": "514-123-1234",
"DateOfBirth": "1980-01-01",
"AddressCivic": "101 Street",
"AddressCity": "Toronto",
"AddressProvince": "ON",
"AddressCountry": "CA",
"AddressPostalCode": "A0A 0A0"
"SelectedAccountId": "dc8b5922-...-ac7e9f7eeed3"

Method: GET

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


idguidUser id
RequestIdstringThe id of the request
CustomerIdstringYour customer id
IdguidCard Id
UpdatedAtdatetimeWhen the card was last updated
CreatedAtdatetimeWhen the card was originally created
InstitutionNamestringThe name of the institution
SelectedAccountIdguidThe selected account id in the Connector. This is the account to be used for EFT payments
IdguidThe account id
InstitutionNumberstringThe institutioin number (used for EFT)
TransitNumberstringThe transit number (used for EFT)
AccountNumberstringThe account number (used for EFT)
TitlestringThe account title
BalancedecimalThe account balance
CurrencystringThe account currency, CAD, USD or OTHER
AccountCategorystringThe account category
AccountSubCategorystringThe account subcategory
DatedatetimeDate when the transaction happened
DescriptionstringTransaction description
DebitdecimalAmount when the transaction is debit
CreditdecimalAmount when the transaction is credit
BalancedecimalBalance of the account at the moment of the transaction
FirstNamestringAccount holder first name
LastNamestringAccount holder last name
FullNamestringAccount holder full name
EmailstringAccount holder email
PhoneNumberstringAccount holder phone number
DateOfBirthstringAccount holder date of birth
AddressCivicstringAccount holder address
AddressCitystringAccount holder address city
AddressProvincestringAccount holder address province
AddressCountrystringAccount holder address country
AddressPostalCodestringAccount holder address postal code

Account Category

OperationAccounts that could be used for day-to-day use, such as EFT, or Savings
ProductAccounts that are sold as a product by the institution, such as investments accounts
CreditCredit Cards
OtherAny other type of account

Account Sub Category

ChequingOperationCheckings account
SavingsOperationSavings account
CreditCardCreditCredit card accounts
CreditCardPrepaidCreditPre-paid cards
GICProductGIC accounts
LineOfCreditProductAny line of credit account
LoanStudentProductStudent loans accounts
RRSPProductRRSP accounts
LoanProductAny other loan account
GICProductGIC accounts
TFSAProductTFSA accounts
MortgageProductMortgage accounts