In this example we will review how to find existing accounts by personId.
Searching for accounts that belong to the person ID-3392.
...persons/ID-3392/accounts...
Requesting to display the search results on the first page; the page size is 5.
...?pageNumber=1&pageSize=5
To find person accounts, make the following API call.
GET https://account-api.sandbox.tuumplatform.com/api/v5/persons/{personId}/accounts
Below is the example request of the call for finding person accounts.
https://account-api.{{env}}.{{domain}}/api/v5/persons/ID-3392/accounts?pageNumber=1&pageSize=5curl -L 'https://account-api.sandbox.tuumplatform.com/api/v5/persons/ID-3392/accounts?pageNumber=1&pageSize=5' \
-H 'x-channel-code: SYSTEM' \
-H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDctMTBUMTQ6NTk6MDUiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2ODkwMDExNDV9.CDrDuZ-2fAgeA_7KEdHNbjYup1tD8Vgs_kwkkDZ7NOw' \
-d ''Below you find an example response body to the API call above.
{
"errors": null,
"validationErrors": null,
"data": {
"values": [
{
"accountId": "ID-1283",
"personId": "ID-3392",
"accountTypeCode": "VIRTUAL",
"activationDate": "2023-06-26",
"accountName": null,
"personName": "Trevor Harry Tuum",
"statusCode": "ACTIVE",
"iban": "GB05XXXX04030100000462",
"bic": "LHVBGB2LXXX",
"defaultCurrencyCode": "GBP",
"tenantCode": "MB",
"residencyCode": "GB",
"customerGroupCode": "GROUP_B",
"personTypeCode": null,
"intraOrgCode": null,
"accountTypeSetupCode": "STANDARD",
"serviceProviderCode": "TUUM",
"interestMethodAssignmentCode": null,
"accountClassCode": null,
"balances": [],
"masterAccountId": "ID-1279",
"accountNumbers": [
{
"accountNumber": {
"value": "00000462",
"type": "BBAN"
},
"countryCode": "GB",
"financialInstitutionId": {
"value": "040301",
"type": "SORT_CODE"
},
"defaultCurrencyCode": "GBP",
"accountNumberId": "ID-1144",
"accountId": "ID-1283",
"financialInstitutionIdTypeCode": null,
"statusCode": "ENABLED"
}
],
"taxResidencyCountryCode": "GB",
"jurisdictionCountryCode": "GB"
},
{
"accountId": "ID-1282",
"personId": "ID-3392",
"accountTypeCode": "INTERNAL",
"activationDate": "2023-06-26",
"accountName": null,
"personName": "Trevor Harry Tuum",
"statusCode": "ACTIVE",
"iban": "XX54XXXX99999000000000000001257",
"bic": "ICECLOUDXXX",
"defaultCurrencyCode": "EUR",
"tenantCode": "MB",
"residencyCode": "GB",
"customerGroupCode": "INTERNAL",
"personTypeCode": null,
"intraOrgCode": null,
"accountTypeSetupCode": "STANDARD",
"serviceProviderCode": "TUUM",
"interestMethodAssignmentCode": null,
"accountClassCode": null,
"balances": [
{
"balanceId": "ID-1209",
"accountId": "ID-1282",
"currencyCode": "EUR",
"balanceAmount": 0.00,
"reservedAmount": 0.00,
"overdraftLimitAmount": 0.00,
"defaultCurrencyCode": "EUR",
"availableBalanceInDefaultCcy": 0.00,
"negativeBalanceStartDate": null,
"availableBalanceAmount": 0.00
}
],
"masterAccountId": null,
"accountNumbers": [],
"taxResidencyCountryCode": "GB",
"jurisdictionCountryCode": "GB"
},
{
"accountId": "ID-1281",
"personId": "ID-3392",
"accountTypeCode": "INTERNAL",
"activationDate": "2023-06-26",
"accountName": "Internal BO",
"personName": "Trevor",
"statusCode": "ACTIVE",
"iban": "XX17XXXX99999000000000000001244",
"bic": "ICECLOUDXXX",
"defaultCurrencyCode": "EUR",
"tenantCode": "MB",
"residencyCode": "GB",
"customerGroupCode": "INTERNAL",
"personTypeCode": "P",
"intraOrgCode": null,
"accountTypeSetupCode": "STANDARD",
"serviceProviderCode": "TUUM",
"interestMethodAssignmentCode": null,
"accountClassCode": null,
"balances": [
{
"balanceId": "ID-1208",
"accountId": "ID-1281",
"currencyCode": "EUR",
"balanceAmount": 0.00,
"reservedAmount": 0.00,
"overdraftLimitAmount": 0.00,
"defaultCurrencyCode": "EUR",
"availableBalanceInDefaultCcy": 0.00,
"negativeBalanceStartDate": null,
"availableBalanceAmount": 0.00
}
],
"masterAccountId": null,
"accountNumbers": [],
"taxResidencyCountryCode": "GB",
"jurisdictionCountryCode": "GB"
},
{
"accountId": "ID-1279",
"personId": "ID-3392",
"accountTypeCode": "CURRENCY",
"activationDate": "2023-06-19",
"accountName": null,
"personName": "Trevor Harry Tuum",
"statusCode": "ACTIVE",
"iban": "GB72XXXX04030000000986",
"bic": "LHVBGB2LXXX",
"defaultCurrencyCode": "GBP",
"tenantCode": "MB",
"residencyCode": "GB",
"customerGroupCode": "GROUP_A",
"personTypeCode": null,
"intraOrgCode": null,
"accountTypeSetupCode": "STANDARD",
"serviceProviderCode": "TUUM",
"interestMethodAssignmentCode": null,
"accountClassCode": null,
"balances": [
{
"balanceId": "ID-1212",
"accountId": "ID-1279",
"currencyCode": "EUR",
"balanceAmount": -5.00,
"reservedAmount": 0.00,
"overdraftLimitAmount": 0.00,
"defaultCurrencyCode": "GBP",
"availableBalanceInDefaultCcy": -4.24,
"negativeBalanceStartDate": "2023-07-01",
"availableBalanceAmount": -5.00
},
{
"balanceId": "ID-1206",
"accountId": "ID-1279",
"currencyCode": "GBP",
"balanceAmount": 0.00,
"reservedAmount": 0.00,
"overdraftLimitAmount": 0.00,
"defaultCurrencyCode": "GBP",
"availableBalanceInDefaultCcy": 0.00,
"negativeBalanceStartDate": null,
"availableBalanceAmount": 0.00
}
],
"masterAccountId": null,
"accountNumbers": [
{
"accountNumber": {
"value": "00000986",
"type": "BBAN"
},
"countryCode": "GB",
"financialInstitutionId": {
"value": "040300",
"type": "SORT_CODE"
},
"defaultCurrencyCode": "GBP",
"accountNumberId": "ID-1143",
"accountId": "ID-1279",
"financialInstitutionIdTypeCode": null,
"statusCode": "ENABLED"
}
],
"taxResidencyCountryCode": "GB",
"jurisdictionCountryCode": "GB"
}
],
"pageNumber": 1,
"pageSize": 5,
"endReached": true,
"sort": null,
"total": 4
}
}The person account information is fetched.
https://account-api.sandbox.tuumplatform.com/api/v5/persons/{personId}/accounts
See more information about the endpoint in the Tuum developer portal.
See more information about this in the Tuum developer portal.