List Applications
Request URL
POST /akepa/list
Description
This endpoint will list applications that match the desired customerId and optional date range. You may also specify a maximum number of records to return using the numberOfRecords
property (up to 1000) and you may specify a number of records to skip using the skipRecords
property. Combine the numberOfRecords
property with the skipRecords
property to make displaying application lists in batches easy. For example, if you want to list applications in batches of 5, you can set numberOfRecords
to 5 and skipRecords
to 0 in the first request. Then, increase skipRecords
by 5 in each subsequent request to return the next batch and so on.
When making a request, if the number of applications matching the criteria is greater than the numberOfRecords
maximum requested, the response body will indicate that there are additional applications ("more": true).
If no optional search properties are included, an unfiltered application list will be returned (up to a maximum of 1000).
Schema
Property table for akepa/list
Property | Description | Required | Schema |
---|---|---|---|
customerId | Customer ID in connectFi | Yes | { "type": "string", "pattern": "^[0-9a-zA-Z_]+$", "minLength": 1, "maxLength": 36, "$id": "common-id" } |
dateCreateFrom | A beginning date in ISO Date format | No | { "type": "string", "format": "dateISO", "nullable": true } |
dateCreateTo | An ending date in ISO Date format | No | { "type": "string", "format": "dateISO", "nullable": true } |
numberOfRecords | The maximum number of desired records to return | No | { "type": "integer", "minimum": 1, "nullable": true, "$id": "common-numberOfRecords" } |
skipRecords | The number of records to skip when returning results | No | { "type": "integer", "minimum": 0, "nullable": true, "$id": "common-skipRecords" } |
Request Body
{
"customerId": "cstap_5mBHiIx3QbkvEpjGfKsI9k",
"dateCreateFrom": "2023-01-15T00:00:00.001Z",
"dateCreateTo": "2099-01-17T19:59:59.999Z",
"numberOfRecords": 20,
"skipRecords": 0
}
Snippet Examples
javascript
const axios = require('axios');
const data = {
"customerId": "cstap_5mBHiIx3QbkvEpjGfKsI9k",
"dateCreateFrom": "2023-01-15T00:00:00.001Z",
"dateCreateTo": "2099-01-17T19:59:59.999Z",
"numberOfRecords": 20,
"skipRecords": 0
};
const config = {
method: 'POST',
url: '${CONNECTFI_BASE_URL}/akepa/list',
headers: {
'Content-Type': "application/json",
'x-connectfi-token': "A long random string token received from /auth/get-token request"
},
data
};
let result;
try {
result = await axios.request(config);
if (result.status === 200) {
console.log(JSON.stringify(result.data));
}
} catch (err) {
console.log({
errCode: err.code,
responseStatus: err.response && err.response.status,
data: err.response && JSON.stringify(err.response.data)
});
}
cURL
curl --location "CONNECTFI_BASE_URL/akepa/list" --data "{ \"customerId\":\"cstap_5mBHiIx3QbkvEpjGfKsI9k\", \"dateCreateFrom\":\"2023-01-15T00:00:00.001Z\", \"dateCreateTo\":\"2099-01-17T19:59:59.999Z\", \"numberOfRecords\":20, \"skipRecords\":0}" --header "Content-Type: application/json" --header "x-connectfi-token: A long random string token received from /auth/get-token request"
Successful Response Examples
200 AKEPA/LIST SUCCESSFUL RESPONSE
HEADERS
Header | Value |
---|---|
Content-Type | application/json |
x-connectfi-token | A long random string token received from /auth/get-token request |
REQUEST BODY
{
"customerId": "cstap_5mBHiIx3QbkvEpjGfKsI9k",
"dateCreateFrom": "2023-01-15T00:00:00.001Z",
"dateCreateTo": "2099-01-17T19:59:59.999Z",
"numberOfRecords": 20,
"skipRecords": 0
}
RESPONSE BODY
{
"code": "0",
"data": {
"items": [
{
"applicationId": "iapp_1BGgJeDQJFo5MCup15zq9A",
"aggregatorId": "CLIENTID",
"customerId": "cstap_5mBHiIx3QbkvEpjGfKsI9k",
"reference": "extRefApp101",
"status": "pending_step_up",
"outcome": null,
"entityApplications": [
{
"entityId": "cstap_5mBHiIx3QbkvEpjGfKsI9k",
"isCustomer": true,
"status": "pending_step_up",
"outcome": null
}
]
},
{
"applicationId": "iapp_ASiuCX9tz9FGwlyiNHba2",
"aggregatorId": "CLIENTID",
"customerId": "cstap_5mBHiIx3QbkvEpjGfKsI9k",
"reference": "extRefApp100",
"status": "pending_step_up",
"outcome": null,
"entityApplications": [
{
"entityId": "cstap_5mBHiIx3QbkvEpjGfKsI9k",
"isCustomer": true,
"status": "pending_step_up",
"outcome": null
}
]
}
],
"total": {
"skipRecords": 0,
"numberOfRecords": 2,
"more": false
}
},
"requestId": "9651a640b9fa11eeb6a5bb65dd1aad12"
}
200 AKEPA/LIST SUCCESSFUL RESPONSE - NO APPLICATIONS MEET SEARCH CRITERIA
HEADERS
Header | Value |
---|---|
Content-Type | application/json |
x-connectfi-token | A long random string token received from /auth/get-token request |
REQUEST BODY
{
"customerId": "cstap_5mBHiIx3QbkvEpjGfKsI9k1",
"dateCreateFrom": "2023-01-15T00:00:00.001Z",
"dateCreateTo": "2099-01-17T19:59:59.999Z",
"numberOfRecords": 20,
"skipRecords": 0
}
RESPONSE BODY