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
Response
| 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 |
| 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
| 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 |
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 |