API Endpoints

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.

Few important points regarding the date and amount fields in the request payload:

1. Supported date formats are DD/MM/YYYY, YYYYMMDD or YYYY-MM-DD

2. Debit amounts are indicated with a negative (-) sign

Send banking transaction data for insights analysis

post

This endpoint is provided to allows customers to send MogoPlus banking data in a single payload. MogoPlus does not set bounds on the data submitted, so API consumers can submit the data pertinent to their needs. 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 applicants or across multiple accounts in a single request.

Authorizations

Body

Banking data supplied by customer participant

applicantsDataobject[]Optional

Responses

application/json

objectOptional

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

post

HTTPcURLJavaScriptPython

POST /api/application/api/application HTTP/1.1
Host: console.live.mogoplus.ai
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 272

{
  "applicantsData": [
    {
      "applicant": {
        "firstName": "text",
        "lastName": "text",
        "employerNames": [
          "text"
        ]
      },
      "bankingTransactionData": {
        "institutions": [
          {
            "institutionName": "text",
            "accounts": [
              {
                "accountNumber": "text",
                "transactions": [
                  {
                    "description": "text",
                    "amount": 1,
                    "date": "text"
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  ]
}

{
  "data": {
    "insightsId": {
      "insightsId": "text"
    },
    "insightsReport": {
      "subscriptionId": "9e58813c-7c2a-11ee-b962-0242ac120002",
      "report": "https://console.live.mogoplus.ai/api/application/c8c7d799-fe50-43bb-8e61-f08cd8a9434"
    }
  },
  "links": {
    "self": "https://console.live.mogoplus.ai/api/application/c8c7d799-fe50-43bb-8e61-f08cd8a9434f"
  }
}

Retrieve the banking data insights report

get

This endpoint provides the insights report. If processing is ongoing the endpoint will return a 204 to indicate no data is available.

Authorizations

Path parameters

applicationIdstringRequired

A valid V4 UUID

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$

Responses

application/json

objectOptional

Provides both the state of processing and the response data. Whilst processing is ongoing the data object will be omitted.

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

get

HTTPcURLJavaScriptPython

GET /api/application/api/application/{applicationId} HTTP/1.1
Host: console.live.mogoplus.ai
Authorization: Bearer JWT
Accept: */*

{
  "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,
              "Average": 1
            },
            "debit": {
              "sumAmount": 1,
              "numberOfTransactions": 1,
              "Average": 1
            }
          },
          "combinedCategoryGroupSummary": {
            "combinedCategoryGroups": [
              {
                "categoryGroup": "text",
                "categoryGroupDescription": "text",
                "debit": {
                  "sumAmount": 1,
                  "numberOfTransactions": 1,
                  "Average": 1
                },
                "credit": {
                  "sumAmount": 1,
                  "numberOfTransactions": 1,
                  "Average": 1
                }
              }
            ]
          },
          "combinedCategorySummary": {
            "combined": [
              {
                "categoryCode": "text",
                "categoryCodeDescription": "text",
                "credit": {
                  "sumAmount": 1,
                  "numberOfTransactions": 1,
                  "Average": 1
                },
                "debit": {
                  "sumAmount": 1,
                  "numberOfTransactions": 1,
                  "Average": 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,
                  "Average": 1
                },
                "debit": {
                  "sumAmount": 1,
                  "numberOfTransactions": 1,
                  "Average": 1
                }
              },
              "applicantCategoryGroupSummary": {
                "applicantCategoryGroups": [
                  {
                    "categoryGroup": "text",
                    "categoryGroupDescription": "text",
                    "debit": {
                      "sumAmount": 1,
                      "numberOfTransactions": 1,
                      "Average": 1
                    },
                    "credit": {
                      "sumAmount": 1,
                      "numberOfTransactions": 1,
                      "Average": 1
                    }
                  }
                ]
              },
              "applicantCategorySummary": {
                "categories": [
                  {
                    "categoryCode": "text",
                    "categoryCodeDescription": "text",
                    "credit": {
                      "sumAmount": 1,
                      "numberOfTransactions": 1,
                      "Average": 1
                    },
                    "debit": {
                      "sumAmount": 1,
                      "numberOfTransactions": 1,
                      "Average": 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"
              },
              "categoryReview": [
                {
                  "categoryCode": "text",
                  "categoryCodeDescription": "text",
                  "credit": {
                    "sumAmount": 1,
                    "numberOfTransactions": 1,
                    "Average": 1
                  },
                  "debit": {
                    "sumAmount": 1,
                    "numberOfTransactions": 1,
                    "Average": 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"
}