The below provides developers with essential information on how to integrate and interact with the API, covering key methods, data formats, request/response structures, and error handling protocols.
Last updated
Was this helpful?
Allows an API consumer to purge the result set for a given insights Id
A valid V4 UUID
^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$DELETE /cdr-data/v2/cdr-data/v2/banking-data-insights/{insightsId} HTTP/1.1
Host: apigateway.auuat.mogoplus.com
Authorization: Bearer JWT
Accept: */*
No content
This endpoint provides the insights report. If processing is ongoing the endpoint will return a 204 to indicate no data is available.
A valid V4 UUID
^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$A valid V4 UUID
^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$Provides both the state of processing and the response data. Whilst processing is ongoing the data object will be omitted.
GET /cdr-data/v2/cdr-data/v2/banking-data-insights/{insightsId}/orders/{orderId} HTTP/1.1
Host: apigateway.auuat.mogoplus.com
Authorization: Bearer JWT
Accept: */*
{
"meta": {
"status": "ACCEPTED"
},
"insightsHeader": {
"insightsId": "text",
"insightsPublishDate": "text",
"clientId": "text",
"clientName": "text",
"reports": [
{
"reportHeader": {
"reportId": "text",
"reportPublishDate": "text",
"reportingPeriodStartDate": "text",
"reportingPeriodEndDate": "text",
"applicationType": "text",
"numberOfApplicants": 1,
"numberOfDaysInReportingPeriod": 1,
"applicants": [
{
"applicantId": "text",
"applicantName": "text"
}
]
},
"combinedSummary": {
"combinedNumberOfInstitutions": 1,
"combinedNumberOfAccounts": 1,
"combinedNumberOfTransactions": 1,
"currency": "text",
"combinedTotalSummary": {
"credit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"debit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
}
},
"combinedCategoryGroupSummary": {
"combinedCategoryGroups": [
{
"categoryGroup": "text",
"categoryGroupDescription": "text",
"debit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"credit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
}
}
]
},
"combinedCategorySummary": {
"combined": [
{
"categoryCode": "text",
"categoryCodeDescription": "text",
"credit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"debit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
}
}
]
},
"netMonthlyPosition": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"combinedIncomeInsights": {
"basicIncomeInsights": {
"currency": "text",
"income": {
"sumAmount": 1,
"numberOfTransactions": 1,
"averageMonthly": 1
},
"incomeBuckets": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
}
},
"applicantSummary": {
"applicants": [
{
"applicantName": "text",
"numberOfInstitutions": 1,
"numberOfAccounts": 1,
"numberOfTransactions": 1,
"currency": "text",
"applicantTotalSummary": {
"credit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"debit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
}
},
"applicantCategoryGroupSummary": {
"applicantCategoryGroups": [
{
"categoryGroup": "text",
"categoryGroupDescription": "text",
"debit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"credit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
}
}
]
},
"applicantCategorySummary": {
"categories": [
{
"categoryCode": "text",
"categoryCodeDescription": "text",
"credit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"debit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
}
}
]
},
"applicantDetailedTransaction": {
"institutions": [
{
"institutionId": "text",
"institutionName": "text",
"accounts": [
{
"accountNumber": "text",
"accountName": "text",
"currentBalance": 1,
"availableBalance": 1,
"creditLimit": 1,
"numberOfTransactionsInTotal": 1,
"numberOfTransactionsCategorised": 1,
"transactions": [
{
"transactionId": "text",
"transactionDate": "text",
"transactionCategoryGroup": "text",
"transactionCategoryCode": "text",
"transactionDescription": "text",
"transactionAmount": 1,
"transactionCurrency": "text"
}
]
}
]
}
]
},
"netMonthlyPosition": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"alerts": [
{
"categoryCode": "text",
"categoryCodeDescription": "text",
"credit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"debit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"transactions": [
{
"transactionId": "text",
"transactionDate": "text",
"transactionCategoryGroup": "text",
"transactionCategoryCode": "text",
"transactionDescription": "text",
"transactionAmount": 1,
"transactionCurrency": "text"
}
]
}
]
}
]
},
"incomeSummary": {
"applicants": [
{
"applicantName": "text",
"employmentInsights": [
{
"declaredEmployerName": "text",
"employerNameVerified": true,
"latestEmployerVerifiedSalaryDate": "text",
"latestEmployerVerifiedSalaryAmount": 1
}
],
"IncomeInsights": {
"basicIncomeInsights": {
"currency": "text",
"income": {
"sumAmount": 1,
"numberOfTransactions": 1,
"averageMonthly": 1
},
"incomeBuckets": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"inferentialIncomeInsights": [
{
"type": "text",
"employer": "text",
"recency": {
"daysInLastPeriod": 1,
"numberOfTransactionsInLastPeriod": 1
},
"regularity": {
"numberOfTransactions": 1,
"incomeDates": [
"text"
],
"statisticsOfDayIntervals": {
"max": 1,
"min": 1,
"mean": 1,
"median": 1,
"mode": 1,
"standardDeviation": 1
}
},
"reliability": {
"numberOfTransactions": 1,
"incomeAmounts": [
{
"date": "text",
"amount": 1
}
],
"statisticsOfSalaryAmount": {
"average": 1,
"median": 1,
"mode": 1,
"range": 1,
"standardDeviation": 1
}
}
}
]
}
}
]
}
}
]
},
"reportString": "text"
}This endpoint provides the insights report. If processing is ongoing the endpoint will return a 204 to indicate no data is available.
A valid V4 UUID
^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$Provides both the state of processing and the response data. Whilst processing is ongoing the data object will be omitted.
GET /cdr-data/v2/cdr-data/v2/banking-data-insights/{insightsId} HTTP/1.1
Host: apigateway.auuat.mogoplus.com
Authorization: Bearer JWT
Accept: */*
{
"meta": {
"status": "ACCEPTED"
},
"insightsHeader": {
"insightsId": "text",
"insightsPublishDate": "text",
"clientId": "text",
"clientName": "text",
"reports": [
{
"reportHeader": {
"reportId": "text",
"reportPublishDate": "text",
"reportingPeriodStartDate": "text",
"reportingPeriodEndDate": "text",
"applicationType": "text",
"numberOfApplicants": 1,
"numberOfDaysInReportingPeriod": 1,
"applicants": [
{
"applicantId": "text",
"applicantName": "text"
}
]
},
"combinedSummary": {
"combinedNumberOfInstitutions": 1,
"combinedNumberOfAccounts": 1,
"combinedNumberOfTransactions": 1,
"currency": "text",
"combinedTotalSummary": {
"credit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"debit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
}
},
"combinedCategoryGroupSummary": {
"combinedCategoryGroups": [
{
"categoryGroup": "text",
"categoryGroupDescription": "text",
"debit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"credit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
}
}
]
},
"combinedCategorySummary": {
"combined": [
{
"categoryCode": "text",
"categoryCodeDescription": "text",
"credit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"debit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
}
}
]
},
"netMonthlyPosition": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"combinedIncomeInsights": {
"basicIncomeInsights": {
"currency": "text",
"income": {
"sumAmount": 1,
"numberOfTransactions": 1,
"averageMonthly": 1
},
"incomeBuckets": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
}
},
"applicantSummary": {
"applicants": [
{
"applicantName": "text",
"numberOfInstitutions": 1,
"numberOfAccounts": 1,
"numberOfTransactions": 1,
"currency": "text",
"applicantTotalSummary": {
"credit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"debit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
}
},
"applicantCategoryGroupSummary": {
"applicantCategoryGroups": [
{
"categoryGroup": "text",
"categoryGroupDescription": "text",
"debit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"credit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
}
}
]
},
"applicantCategorySummary": {
"categories": [
{
"categoryCode": "text",
"categoryCodeDescription": "text",
"credit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"debit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
}
}
]
},
"applicantDetailedTransaction": {
"institutions": [
{
"institutionId": "text",
"institutionName": "text",
"accounts": [
{
"accountNumber": "text",
"accountName": "text",
"currentBalance": 1,
"availableBalance": 1,
"creditLimit": 1,
"numberOfTransactionsInTotal": 1,
"numberOfTransactionsCategorised": 1,
"transactions": [
{
"transactionId": "text",
"transactionDate": "text",
"transactionCategoryGroup": "text",
"transactionCategoryCode": "text",
"transactionDescription": "text",
"transactionAmount": 1,
"transactionCurrency": "text"
}
]
}
]
}
]
},
"netMonthlyPosition": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"alerts": [
{
"categoryCode": "text",
"categoryCodeDescription": "text",
"credit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"debit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"transactions": [
{
"transactionId": "text",
"transactionDate": "text",
"transactionCategoryGroup": "text",
"transactionCategoryCode": "text",
"transactionDescription": "text",
"transactionAmount": 1,
"transactionCurrency": "text"
}
]
}
]
}
]
},
"incomeSummary": {
"applicants": [
{
"applicantName": "text",
"employmentInsights": [
{
"declaredEmployerName": "text",
"employerNameVerified": true,
"latestEmployerVerifiedSalaryDate": "text",
"latestEmployerVerifiedSalaryAmount": 1
}
],
"IncomeInsights": {
"basicIncomeInsights": {
"currency": "text",
"income": {
"sumAmount": 1,
"numberOfTransactions": 1,
"averageMonthly": 1
},
"incomeBuckets": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"inferentialIncomeInsights": [
{
"type": "text",
"employer": "text",
"recency": {
"daysInLastPeriod": 1,
"numberOfTransactionsInLastPeriod": 1
},
"regularity": {
"numberOfTransactions": 1,
"incomeDates": [
"text"
],
"statisticsOfDayIntervals": {
"max": 1,
"min": 1,
"mean": 1,
"median": 1,
"mode": 1,
"standardDeviation": 1
}
},
"reliability": {
"numberOfTransactions": 1,
"incomeAmounts": [
{
"date": "text",
"amount": 1
}
],
"statisticsOfSalaryAmount": {
"average": 1,
"median": 1,
"mode": 1,
"range": 1,
"standardDeviation": 1
}
}
}
]
}
}
]
}
}
]
},
"reportString": "text"
}This endpoint is provided to allow CDR participants to send MogoPlus banking data in a single payload. It combines the following endpoints from the CDR OpenAPI document: * /banking/accounts/{accountId} (see notes below on implementation) * /banking/accounts/balances * /banking/accounts/direct-debits * /banking/accounts/{accountId}/transactions (see notes below on implementation) * /banking/accounts/payments/scheduled If a given dataset is not required for insights analysis - for example, balances is not required - the data can simply be omitted. The minimum requirements will, however is account and transaction data, which must be supplied for meaningful analysis to take place. API consumers can submit data from multiple customers or across multiple accounts in a single request.
Banking data supplied by CDR participant
POST /cdr-data/v2/cdr-data/v2/banking-data-insights HTTP/1.1
Host: apigateway.auuat.mogoplus.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 4706
{
"meta": {
"orderIds": [
"9e58813c-7c2a-11ee-b962-0242ac120002"
],
"clientId": "9e58f48813c-6c4a-11ee-b962-0242ac120002",
"reference": "text",
"applicationType": "PERSONAL_LOAN"
},
"applicantsData": [
{
"applicant": {
"crn": "text",
"firstName": "text",
"lastName": "text",
"emailAddress": "text",
"employerNames": [
"text"
],
"declaredIncome": {
"amount": 1,
"currency": "text"
},
"declaredExpenses": {
"amount": 1,
"currency": "text"
}
},
"bankingTransactionData": [
{
"consentProperty": {
"institutionName": "text",
"consent": {
"arrangementId": "0a29c52b-df25-4bfd-83e1-c0ba53fc218e",
"scopes": [
"bank:accounts.basic:read"
],
"sharingStartDateTime": "2025-04-20T10:00:35.947Z",
"sharingDuration": 86400
}
},
"accountProperty": {
"accounts": [
{
"accountId": "text",
"creationDate": "text",
"displayName": "text",
"nickname": "text",
"openStatus": "CLOSED",
"isOwned": true,
"accountOwnership": "UNKNOWN",
"maskedNumber": "text",
"productCategory": "BUSINESS_LOANS",
"productName": "text",
"balance": {
"accountId": "accountId",
"purses": [
{
"amount": "amount",
"currency": "currency"
},
{
"amount": "amount",
"currency": "currency"
}
],
"amortisedLimit": "amortisedLimit",
"currentBalance": "currentBalance",
"creditLimit": "creditLimit",
"currency": "currency",
"availableBalance": "availableBalance"
},
"transactions": [
{
"accountId": "d6fe752c-219b-4453-adbf-6d258538b7fb",
"transactionId": "219b-4453-adbf-6d258538b7fb-d6fe752c",
"isDetailAvailable": false,
"type": "PAYMENT",
"status": "POSTED",
"description": "eCommerce transaction",
"amount": "58.67",
"reference": "Menulog Order Reference #23347506",
"valueDateTime": "2022-10-12T17:56:51.6Z"
},
{
"accountId": "d6fe752c-219b-4453-adbf-6d258538b7fb",
"transactionId": "219b-4453-adbf-6d258538b7fb-d6fe752c",
"isDetailAvailable": false,
"type": "TRANSFER_INCOMING",
"status": "PENDING",
"description": "Inter-account transfer",
"amount": "100.00",
"reference": "Birthday money from Mum",
"valueDateTime": "2022-11-12T17:56:51.6Z"
}
],
"directDebitAuthorisations": [
{
"lastDebitAmount": "lastDebitAmount",
"accountId": "accountId",
"lastDebitDateTime": "lastDebitDateTime",
"authorisedEntity": {
"arbn": "arbn",
"description": "description",
"financialInstitution": "financialInstitution",
"abn": "abn",
"acn": "acn"
}
}
],
"scheduledPayments": [
{
"recurrence": {
"nextPaymentDate": "nextPaymentDate",
"eventBased": {
"description": "description"
},
"onceOff": {
"paymentDate": "paymentDate"
},
"recurrenceUType": "eventBased",
"intervalSchedule": {
"intervals": [
{
"interval": "interval",
"dayInInterval": "dayInInterval"
},
{
"interval": "interval",
"dayInInterval": "dayInInterval"
}
],
"paymentsRemaining": 1,
"finalPaymentDate": "finalPaymentDate",
"nonBusinessDayTreatment": "ON"
},
"lastWeekDay": {
"paymentsRemaining": 1,
"interval": "interval",
"finalPaymentDate": "finalPaymentDate",
"lastWeekDay": "FRI",
"nonBusinessDayTreatment": "ON"
}
},
"scheduledPaymentId": "scheduledPaymentId",
"payeeReference": "payeeReference",
"payerReference": "payerReference",
"nickname": "nickname",
"from": {
"accountId": "accountId"
},
"paymentSet": [
{
"isAmountCalculated": true,
"amount": "amount",
"currency": "currency",
"to": {
"domestic": {
"payeeAccountUType": "account",
"payId": {
"identifier": "identifier",
"name": "name",
"type": "ABN"
},
"account": {
"bsb": "bsb",
"accountName": "accountName",
"accountNumber": "accountNumber"
},
"card": {
"cardNumber": "cardNumber"
}
},
"accountId": "accountId",
"biller": {
"billerName": "billerName",
"crn": "crn",
"billerCode": "billerCode"
},
"payeeReference": "payeeReference",
"toUType": "accountId",
"nickname": "nickname",
"payeeId": "payeeId",
"international": {
"bankDetails": {
"country": "country",
"routingNumber": "routingNumber",
"fedWireNumber": "fedWireNumber",
"chipNumber": "chipNumber",
"legalEntityIdentifier": "legalEntityIdentifier",
"accountNumber": "accountNumber",
"bankAddress": {
"address": "address",
"name": "name"
},
"sortCode": "sortCode",
"beneficiaryBankBIC": "beneficiaryBankBIC"
},
"beneficiaryDetails": {
"country": "country",
"name": "name",
"message": "message"
}
}
}
},
{
"isAmountCalculated": true,
"amount": "amount",
"currency": "currency",
"to": {
"domestic": {
"payeeAccountUType": "account",
"payId": {
"identifier": "identifier",
"name": "name",
"type": "ABN"
},
"account": {
"bsb": "bsb",
"accountName": "accountName",
"accountNumber": "accountNumber"
},
"card": {
"cardNumber": "cardNumber"
}
},
"accountId": "accountId",
"biller": {
"billerName": "billerName",
"crn": "crn",
"billerCode": "billerCode"
},
"payeeReference": "payeeReference",
"toUType": "accountId",
"nickname": "nickname",
"payeeId": "payeeId",
"international": {
"bankDetails": {
"country": "country",
"routingNumber": "routingNumber",
"fedWireNumber": "fedWireNumber",
"chipNumber": "chipNumber",
"legalEntityIdentifier": "legalEntityIdentifier",
"accountNumber": "accountNumber",
"bankAddress": {
"address": "address",
"name": "name"
},
"sortCode": "sortCode",
"beneficiaryBankBIC": "beneficiaryBankBIC"
},
"beneficiaryDetails": {
"country": "country",
"name": "name",
"message": "message"
}
}
}
}
],
"status": "ACTIVE"
}
]
}
]
}
}
]
}
]
}{
"data": {
"insightsId": {
"insightsId": "text"
},
"orderReports": [
{
"orderId": "9e58813c-7c2a-11ee-b962-0242ac120002",
"report": "https://apigateway.auuat.mogoplus.com/cdr-data/v2/banking-data-insights/c8c7d799-fe50-43bb-8e61-f08cd8a9434/orders/31456b3a-7cf4-11ee-b962-0242ac120002"
}
]
},
"links": {
"self": "https://apigateway.auuat.mogoplus.com/cdr-data/v2/banking-data-insights/c8c7d799-fe50-43bb-8e61-f08cd8a9434f"
}
}