Response structure
To access sequencing data, use the Sequencing API endpoint. The result is sent back in one result set containing all the found sequences and a collection of corresponding transactions.
Source data
Sequences are based on transactions data from a consent or a user. The sequencing algorithms takes at most the latest 13 months of transaction history from the consent or user.
Structure
{
"data": {
"incomeSequences": [
{
"periodicity": "Monthly",
"transactions": [],
"periodMatches": 13,
"periodMatchPercentage": 100,
"amountMatchPercentage": 100,
"timelinessMatchPercentage": 97.827,
"timeConsistency": {
"duration": "365.00:00:00",
"transactionCount": 13,
"firstSeen": "2022-04-26T00:00:00Z",
"lastSeen": "2023-04-26T00:00:00Z",
"mostRecentDayOfPeriod": 26,
"statisticsL12M": {
"minDayOfPeriod": 26,
"maxDayOfPeriod": 28,
"medianDayOfPeriod": 26,
"averageDayOfPeriod": 26.5,
"modeDayOfPeriod": 26,
"stdDevDayOfPeriod": 0.674
},
"statisticsL6M": {
"minDayOfPeriod": 26,
"maxDayOfPeriod": 28,
"medianDayOfPeriod": 27,
"averageDayOfPeriod": 26.833,
"modeDayOfPeriod": 27,
"stdDevDayOfPeriod": 0.752
},
"statisticsL3M": {
"minDayOfPeriod": 26,
"maxDayOfPeriod": 27,
"medianDayOfPeriod": 27,
"averageDayOfPeriod": 26.667,
"modeDayOfPeriod": 27,
"stdDevDayOfPeriod": 0.577
}
},
"amountConsistency": {
"mostRecentAmount": 1400,
"statisticsL12M": {
"minAmount": 1400,
"maxAmount": 1400,
"medianAmount": 1400,
"averageAmount": 1400,
"modeAmount": 1400,
"stdDevAmount": 0,
"totalAmount": 16800
},
"statisticsL6M": {
"minAmount": 1400,
"maxAmount": 1400,
"medianAmount": 1400,
"averageAmount": 1400,
"modeAmount": 1400,
"stdDevAmount": 0,
"totalAmount": 8400
},
"statisticsL3M": {
"minAmount": 1400,
"maxAmount": 1400,
"medianAmount": 1400,
"averageAmount": 1400,
"modeAmount": 1400,
"stdDevAmount": 0,
"totalAmount": 4200
}
}
},
{
"periodicity": "Monthly",
"transactions": [],
"periodMatches": 13,
"periodMatchPercentage": 100,
"amountMatchPercentage": 44.374,
"timelinessMatchPercentage": 96.949,
"timeConsistency": {
"duration": "364.00:00:00",
"transactionCount": 13,
"firstSeen": "2022-04-22T00:00:00Z",
"lastSeen": "2023-04-21T00:00:00Z",
"mostRecentDayOfPeriod": 21,
"statisticsL12M": {
"minDayOfPeriod": 21,
"maxDayOfPeriod": 25,
"medianDayOfPeriod": 23,
"averageDayOfPeriod": 22.833,
"modeDayOfPeriod": 23,
"stdDevDayOfPeriod": 0.937
},
"statisticsL6M": {
"minDayOfPeriod": 21,
"maxDayOfPeriod": 23,
"medianDayOfPeriod": 23,
"averageDayOfPeriod": 22.5,
"modeDayOfPeriod": 23,
"stdDevDayOfPeriod": 0.836
},
"statisticsL3M": {
"minDayOfPeriod": 21,
"maxDayOfPeriod": 23,
"medianDayOfPeriod": 23,
"averageDayOfPeriod": 22.333,
"modeDayOfPeriod": 23,
"stdDevDayOfPeriod": 1.154
}
},
"amountConsistency": {
"mostRecentAmount": 400,
"statisticsL12M": {
"minAmount": 400,
"maxAmount": 1150,
"medianAmount": 400,
"averageAmount": 520.833,
"modeAmount": 400,
"stdDevAmount": 282.407,
"totalAmount": 6250
},
"statisticsL6M": {
"minAmount": 400,
"maxAmount": 400,
"medianAmount": 400,
"averageAmount": 400,
"modeAmount": 400,
"stdDevAmount": 0,
"totalAmount": 2400
},
"statisticsL3M": {
"minAmount": 400,
"maxAmount": 400,
"medianAmount": 400,
"averageAmount": 400,
"modeAmount": 400,
"stdDevAmount": 0,
"totalAmount": 1200
}
}
}
],
"expenseSequences": [
{
"periodicity": "Monthly",
"transactions": [],
"periodMatches": 13,
"periodMatchPercentage": 100,
"amountMatchPercentage": 98.93,
"timelinessMatchPercentage": 96.074,
"timeConsistency": {
"duration": "363.00:00:00",
"transactionCount": 13,
"firstSeen": "2022-04-29T00:00:00Z",
"lastSeen": "2023-04-27T00:00:00Z",
"mostRecentDayOfPeriod": 27,
"statisticsL12M": {
"minDayOfPeriod": 27,
"maxDayOfPeriod": 30,
"medianDayOfPeriod": 28.5,
"averageDayOfPeriod": 28.5833,
"modeDayOfPeriod": 30,
"stdDevDayOfPeriod": 1.24
},
"statisticsL6M": {
"minDayOfPeriod": 27,
"maxDayOfPeriod": 30,
"medianDayOfPeriod": 27.5,
"averageDayOfPeriod": 27.833,
"modeDayOfPeriod": 27,
"stdDevDayOfPeriod": 1.169
},
"statisticsL3M": {
"minDayOfPeriod": 27,
"maxDayOfPeriod": 27,
"medianDayOfPeriod": 27,
"averageDayOfPeriod": 27,
"modeDayOfPeriod": 27,
"stdDevDayOfPeriod": 0
}
},
"amountConsistency": {
"mostRecentAmount": -70.5,
"statisticsL12M": {
"minAmount": -70.5,
"maxAmount": -68.5,
"medianAmount": -70.5,
"averageAmount": -70.333,
"modeAmount": -70.5,
"stdDevAmount": 0.577,
"totalAmount": -844.0
},
"statisticsL6M": {
"minAmount": -70.5,
"maxAmount": -70.5,
"medianAmount": -70.5,
"averageAmount": -70.5,
"modeAmount": -70.5,
"stdDevAmount": 0,
"totalAmount": -423.0
},
"statisticsL3M": {
"minAmount": -70.5,
"maxAmount": -70.5,
"medianAmount": -70.5,
"averageAmount": -70.5,
"modeAmount": -70.5,
"stdDevAmount": 0,
"totalAmount": -211.5
}
}
},
{
"periodicity": "Monthly",
"transactions": [],
"periodMatches": 13,
"periodMatchPercentage": 100,
"amountMatchPercentage": 57.961,
"timelinessMatchPercentage": 97.859,
"timeConsistency": {
"duration": "365.00:00:00",
"transactionCount": 13,
"firstSeen": "2022-04-28T00:00:00Z",
"lastSeen": "2023-04-28T00:00:00Z",
"mostRecentDayOfPeriod": 28,
"statisticsL12M": {
"minDayOfPeriod": 27,
"maxDayOfPeriod": 29,
"medianDayOfPeriod": 27,
"averageDayOfPeriod": 27.333,
"modeDayOfPeriod": 27,
"stdDevDayOfPeriod": 0.651
},
"statisticsL6M": {
"minDayOfPeriod": 27,
"maxDayOfPeriod": 28,
"medianDayOfPeriod": 27,
"averageDayOfPeriod": 27.333,
"modeDayOfPeriod": 27,
"stdDevDayOfPeriod": 0.516
},
"statisticsL3M": {
"minDayOfPeriod": 27,
"maxDayOfPeriod": 28,
"medianDayOfPeriod": 27,
"averageDayOfPeriod": 27.333,
"modeDayOfPeriod": 27,
"stdDevDayOfPeriod": 0.577
}
},
"amountConsistency": {
"mostRecentAmount": -36,
"statisticsL12M": {
"minAmount": -168,
"maxAmount": -36,
"medianAmount": -167,
"averageAmount": -134.5,
"modeAmount": -167,
"stdDevAmount": 59.399,
"totalAmount": -1614
},
"statisticsL6M": {
"minAmount": -168,
"maxAmount": -36,
"medianAmount": -101.5,
"averageAmount": -101.666,
"modeAmount": -36,
"stdDevAmount": 71.935,
"totalAmount": -610
},
"statisticsL3M": {
"minAmount": -36,
"maxAmount": -36,
"medianAmount": -36,
"averageAmount": -36,
"modeAmount": -36,
"stdDevAmount": 0,
"totalAmount": -108
}
}
}
],
"engineVersion": "0.20.0.0"
}
}
Inside the data object, the following objects are available:
| Property | Type | Availability | Description |
|---|---|---|---|
| incomeSequences | array | Required | An array of recognized income sequences in the transactions |
| expenseSequences | array | Required | An array of recognized expense sequences in the transactions. |
| engineVersion | string | Required | The version of the sequencing engine that was used to generate this response. (in SemVer) |
Within the incomeSequences and expenseSequences arrays, the structure of a found sequence is:
Sequence object
| Property | Type | Availability | Description |
|---|---|---|---|
| periodicity | string | Required | The periodicity of this sequence, can be one of the following options: "Weekly", "Monthly", "Quad Weekly", "Quarterly" |
| transactions | array | Required | List of transactions that make up this sequence, the schema of the transactions is the same as in the Account Information API |
| periodMatches | integer | Required | Number of times this sequence had a match in a period in the transactions from the latest 13 months |
| periodMatchPercentage | decimal | Required | Global match percentage of periods in the transactions from the latest 13 months |
| amountMatchPercentage | decimal | Required | Global match percentage of amounts and diversions of this amount in the transactions from the latest 13 months |
| timelinessMatchPercentage | decimal | Required | Global match percentage of timeliness and diversions of this timeliness in the transactions from the latest 13 months |
| timeConsistency | object | Required | TimeConsistency object containing detailed information about the time consistency of this sequence |
| amountConsistency | object | Required | AmountConsistency object containing detailed information about the amount consistency of this sequence |
TimeConsistency object
| Property | Type | Availability | Description |
|---|---|---|---|
| duration | string | Required | The duration between the first and last transaction in the sequence, expressed as: "days.house:minutes:seconds" |
| transactionCount | integer | Required | The number of transactions in the sequence |
| firstSeen | datetime | Required | The Date and Time of the first transaction in the sequence |
| lastSeen | datetime | Required | The Date and Time of the last transaction in the sequence |
| mostRecentDayOfPeriod | integer | Required | The n-th day of the period for the most recent transaction in the sequence |
| statisticsL12M | object | Required | TimeStatistics object containing detailed statistical information about the time consistency of this sequence for the last 12 months |
| statisticsL6M | object | Required | TimeStatistics object containing detailed statistical information about the time consistency of this sequence for the last 6 months |
| statisticsL3M | object | Required | TimeStatistics object containing detailed statistical information about the time consistency of this sequence for the last 3 months |
TimeStatistics object
| Property | Type | Availability | Description |
|---|---|---|---|
| minDayOfPeriod | integer | Required | The minimum n-th day of the period |
| maxDayOfPeriod | integer | Required | The maximum n-th day of the period |
| medianDayOfPeriod | decimal | Required | The median n-th day of the period |
| averageDayOfPeriod | decimal | Required | The average n-th day of the period |
| modeDayOfPeriod | integer | Required | The mode (most found) n-th day of the period |
| stdDevDayOfPeriod | decimal | Required | The standard deviation of the n-th day of the period |
AmountConsistency object
| Property | Type | Availability | Description |
|---|---|---|---|
| mostRecentAmount | decimal | Required | The amount for the most recent transaction in the sequence |
| statisticsL12M | object | Required | AmountStatistics object containing detailed statistical information about the amount consistency of this sequence for the last 12 months |
| statisticsL6M | object | Required | AmountStatistics object containing detailed statistical information about the amount consistency of this sequence for the last 6 months |
| statisticsL3M | object | Required | AmountStatistics object containing detailed statistical information about the amount consistency of this sequence for the last 3 months |
AmountStatistics object
| Property | Type | Availability | Description |
|---|---|---|---|
| minAmount | decimal | Required | The minimum amount of the period |
| maxAmount | decimal | Required | The maximum amount of the period |
| medianAmount | decimal | Required | The median amount of the period |
| averageAmount | decimal | Required | The average amount of the period |
| modeAmount | decimal | Required | The mode (most found) amount of the period |
| stdDevAmount | decimal | Required | The standard deviation of the amounts of the period |
| totalAmount | decimal | Required | The total sum of the amounts of the period |