Sequencing API (v1)

Download OpenAPI specification:Download
Sequencing

Retrieve sequencing information

Authorizations:

bearer
query Parameters

ConsentId	string or null The consent ID for which to retrieve sequencing results
UserId	string or null The User ID for which to retrieve sequencing results
ExternalUserId	string or null The External User ID for which to retrieve sequencing results
Responses

Response samples

Content type
application/json
{"data": {"incomeSequences": [{"periodicity": "string",
"transactions": [{"id": "string",
"accountId": "string",
"accountNumber": "string",
"description": "string",
"bookDate": "string",
"transactionDateTime": "2019-08-24T14:15:22Z",
"amount": 0,
"balanceAfterTransaction": 0,
"currency": "string",
"counterpartDescription": "string",
"counterpartAccountNumber": "string",
"providerProperties": {"providerKey": "string",
"transactionId": "string",
"transactionType": "string",
"transactionTypeName": "string",
"reasonCode": "string",
"purposeCode": "string",
"remittanceInfo": "string",
"remittanceInfoType": "string",
"remittanceInfoIssuer": "string",
"balanceAfterTransaction": 0
},
"category": {"l0Name": "string",
"l1Name": "string",
"l2Name": "string",
"l3Name": "string",
"code": "string"
}
}
],
"periodMatches": 0,
"periodMatchPercentage": 0,
"amountMatchPercentage": 0,
"timelinessMatchPercentage": 0,
"timeConsistency": {"duration": "string",
"transactionCount": 0,
"firstSeen": "2019-08-24T14:15:22Z",
"lastSeen": "2019-08-24T14:15:22Z",
"mostRecentDayOfPeriod": 0,
"statisticsL12M": {"minDayOfPeriod": 0,
"maxDayOfPeriod": 0,
"medianDayOfPeriod": 0.1,
"averageDayOfPeriod": 0.1,
"modeDayOfPeriod": 0,
"stdDevDayOfPeriod": 0
},
"statisticsL6M": {"minDayOfPeriod": 0,
"maxDayOfPeriod": 0,
"medianDayOfPeriod": 0.1,
"averageDayOfPeriod": 0.1,
"modeDayOfPeriod": 0,
"stdDevDayOfPeriod": 0
},
"statisticsL3M": {"minDayOfPeriod": 0,
"maxDayOfPeriod": 0,
"medianDayOfPeriod": 0.1,
"averageDayOfPeriod": 0.1,
"modeDayOfPeriod": 0,
"stdDevDayOfPeriod": 0
}
},
"amountConsistency": {"mostRecentAmount": 0,
"statisticsL12M": {"minAmount": 0,
"maxAmount": 0,
"medianAmount": 0,
"averageAmount": 0,
"modeAmount": 0,
"stdDevAmount": 0,
"totalAmount": 0
},
"statisticsL6M": {"minAmount": 0,
"maxAmount": 0,
"medianAmount": 0,
"averageAmount": 0,
"modeAmount": 0,
"stdDevAmount": 0,
"totalAmount": 0
},
"statisticsL3M": {"minAmount": 0,
"maxAmount": 0,
"medianAmount": 0,
"averageAmount": 0,
"modeAmount": 0,
"stdDevAmount": 0,
"totalAmount": 0
}
}
}
],
"expenseSequences": [{"periodicity": "string",
"transactions": [{"id": "string",
"accountId": "string",
"accountNumber": "string",
"description": "string",
"bookDate": "string",
"transactionDateTime": "2019-08-24T14:15:22Z",
"amount": 0,
"balanceAfterTransaction": 0,
"currency": "string",
"counterpartDescription": "string",
"counterpartAccountNumber": "string",
"providerProperties": {"providerKey": "string",
"transactionId": "string",
"transactionType": "string",
"transactionTypeName": "string",
"reasonCode": "string",
"purposeCode": "string",
"remittanceInfo": "string",
"remittanceInfoType": "string",
"remittanceInfoIssuer": "string",
"balanceAfterTransaction": 0
},
"category": {"l0Name": "string",
"l1Name": "string",
"l2Name": "string",
"l3Name": "string",
"code": "string"
}
}
],
"periodMatches": 0,
"periodMatchPercentage": 0,
"amountMatchPercentage": 0,
"timelinessMatchPercentage": 0,
"timeConsistency": {"duration": "string",
"transactionCount": 0,
"firstSeen": "2019-08-24T14:15:22Z",
"lastSeen": "2019-08-24T14:15:22Z",
"mostRecentDayOfPeriod": 0,
"statisticsL12M": {"minDayOfPeriod": 0,
"maxDayOfPeriod": 0,
"medianDayOfPeriod": 0.1,
"averageDayOfPeriod": 0.1,
"modeDayOfPeriod": 0,
"stdDevDayOfPeriod": 0
},
"statisticsL6M": {"minDayOfPeriod": 0,
"maxDayOfPeriod": 0,
"medianDayOfPeriod": 0.1,
"averageDayOfPeriod": 0.1,
"modeDayOfPeriod": 0,
"stdDevDayOfPeriod": 0
},
"statisticsL3M": {"minDayOfPeriod": 0,
"maxDayOfPeriod": 0,
"medianDayOfPeriod": 0.1,
"averageDayOfPeriod": 0.1,
"modeDayOfPeriod": 0,
"stdDevDayOfPeriod": 0
}
},
"amountConsistency": {"mostRecentAmount": 0,
"statisticsL12M": {"minAmount": 0,
"maxAmount": 0,
"medianAmount": 0,
"averageAmount": 0,
"modeAmount": 0,
"stdDevAmount": 0,
"totalAmount": 0
},
"statisticsL6M": {"minAmount": 0,
"maxAmount": 0,
"medianAmount": 0,
"averageAmount": 0,
"modeAmount": 0,
"stdDevAmount": 0,
"totalAmount": 0
},
"statisticsL3M": {"minAmount": 0,
"maxAmount": 0,
"medianAmount": 0,
"averageAmount": 0,
"modeAmount": 0,
"stdDevAmount": 0,
"totalAmount": 0
}
}
}
],
"engineVersion": "string"
}
}