Find deposit application

Use case

In this case, we will review how to find the ID of a created deposit application using person ID.

Use case data	API parameters with values
We will find an existing deposit application that was created for the test person with ID-2660.	...v2/persons/ID-2660/applications
This API call requires mandatory query parameters pageSize and pageNumber.	...?pageSize=1&pageNumber=1

Sample API call

To find a deposit application, make the following API call.

deposit-api.sandbox.tuumplatform.com/api/v3/persons/{personId}/applications

See more about the find deposit application endpoint in the Tuum developer portal.

Sample response

Below you find an example response body to the API call above.

Response

{
    "errors": null,
    "validationErrors": null,
    "data": {
        "values": [
            {
                "applicationId": "ID-1696407202",
                "personId": "ID-2660",
                "depositGroupCode": "TIME_DEPOSIT",
                "depositTypeCode": "PREMIUM_TEST",
                "statusCode": "ACCEPTED",
                "accountId": "ID-5334",
                "period": 3,
                "periodTypeCode": "MONTH",
                "endDate": null,
                "initialMoney": {
                    "amount": 5000.00,
                    "currencyCode": "EUR"
                },
                "interestPaymentFreqCode": "END",
                "prolongationCode": null,
                "countryCode": "EE",
                "interestRate": 0.25,
                "postingDate": "2024-11-14",
                "channelCode": "SYSTEM",
                "tenantCode": "MB",
                "offerId": null,
                "depositClassCode": "PREMIUM_CUSTOMER",
                "payoutDetails": null,
                "personTypeCode": "P",
                "taxResidencyCountryCode": "EE",
                "taxExempt": false
            }
        ],
        "pageNumber": 1,
        "pageSize": 1,
        "endReached": true,
        "sort": null
    }
}

Result

As a result we found the deposit application with the ID-1696407202 and fetched other information related to the deposit application.