OMN API
Mode
Log in
Orbii OMN API v. 1.0.3
General
-
GET
Welcome message
Clients
-
GET
Get all clients
-
GET
Get clients added within a date range
Transactions
-
GET
Retrieve all transactions
-
GET
Retrieve transactions for a specific customer ID
-
GET
Retrieve transactions for a specific date
-
GET
Get transaction date range
-
GET
Get transactions between a date range
-
GET
Retrieve transactions for a specific client
-
GET
Get transactions for a client on a specific date
-
GET
Get transaction date range for a specific client
-
GET
Get transactions for a client between a date range
-
GET
Get transactions for a specific IBAN
-
GET
Retrieve paginated transactions for a specific customer
-
GET
Retrieve paginated transactions for a specific client
-
POST
Categorise cheque deposits as Equity Transactions or Revenue
-
POST
Categorise partner transactions as Equity Transactions or Transfers
-
GET
Get transactions for a customer within a date range
-
GET
Get paginated transactions for a customer within a date range
IBANs
-
GET
Get distinct IBANs
Categories
-
GET
Get distinct categories for a client
Subcategories
-
GET
Get distinct subcategories for a client
KPIs
-
GET
Retrieve client KPIs for a specific customer ID
-
GET
Retrieve predictive KPIs for a specific customer ID
-
GET
Get KPIs for all clients
-
GET
Get KPIs for a specific client
-
GET
Get predictive KPIs for all clients
-
GET
Get predictive KPIs for a specific client
Data Check
-
GET
Check for new data received
Company Management
-
POST
Add a new company
PDFs
-
GET
Retrieve the list of PDFs with metadata and client details
-
GET
Retrieve PDFs extracted on or after a specific datetime
-
POST
Upload multiple PDFs
-
POST
Trigger PDF extraction pipeline
Merchants
-
GET
Get transactions with merchant details for a customer
-
GET
Get paginated transactions with merchant info by customer ID
-
GET
Get top buyers for a customer
-
GET
Get top sellers for a customer
-
GET
Get top buyers for a customer in the last X months
-
GET
Get top sellers for a customer in the last X months
-
GET
Get transactions-with-me​rchant for a customer within a date range
-
GET
Get paginated transactions-with-me​rchant for a customer within a date range
Risk Assessment
-
GET
Get risk assessment for a specific customer
-
GET
Get band classification for a specific customer
-
POST
Update a KPI rule threshold
-
POST
Reruns Assessment
-
GET
Get band classification for all customers
Business Category Assignment
-
GET
Get business categories with their subcategories
-
POST
Submit customer business category
Lending Actions
-
POST
Log a lending decision from email
Schemas
-
Transaction
-
Client
-
KPI
-
PredictiveKPI
-
CorporateData
-
TransactionCostType
-
TransactionWithMerch​ant
-
PagedTransactionsCos​tType
-
PagedTransactionsWit​hMerchant
-
inline_response_200
-
inline_response_200_​1
-
inline_response_200_​2
-
inline_response_200_​3
-
inline_response_200_​4
-
inline_response_200_​5
-
inline_response_200_​6
-
inline_response_200_​7
-
inline_response_400
-
inline_response_200_​8
-
inline_response_200_​9
-
inline_response_400_​1
-
pdfupload_body
-
inline_response_200_​10
-
inline_response_200_​11
-
inline_response_200_​12
-
inline_response_200_​13
-
inline_response_200_​14
-
inline_response_200_​15
-
inline_response_200_​16
-
inline_response_200_​17
-
inline_response_200_​18
-
updatekpirule_body
-
inline_response_200_​19
-
inline_response_400_​2
-
inline_response_500
-
rerunassessment_body
-
inline_response_200_​20
-
inline_response_400_​3
-
inline_response_500_​1
-
startpdfextraction_b​ody
-
inline_response_200_​21
-
inline_response_400_​4
-
inline_response_409
-
inline_response_500_​2
-
categorisechequedepo​sits_body
-
inline_response_200_​22
-
inline_response_400_​5
-
inline_response_500_​3
-
categorisepartnertra​nsactions_body
-
inline_response_400_​6
-
assigncategory_body
-
loglending_body
-
inline_response_200_​23
-
inline_response_200_​24
-
inline_response_200_​25
-
inline_response_200_​14_transactions
Routing
Open in Explore
Generate Code