UAE API
Mode
Log in
Orbii API v. 1.0.5-oas3
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-merchant for a customer within a date range
-
GET
Get paginated transactions-with-merchant 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
Invoices
-
POST
Upload Excel invoice extract
-
POST
Start invoice extraction pipeline
-
GET
Get invoice KPIs by customer_id
-
GET
Get invoice risk assessments by customer_id
-
GET
Get invoice band classification by customer_id
-
GET
Get invoice KPIs by company for a customer
-
GET
Get invoice risk assessments by company for a customer
-
GET
Get invoice band classifications by company for a customer
-
GET
Get invoice suggested loan by customer_id
-
GET
Get suggested loan allocation by company for a customer
-
GET
Get suggested-loan summary for a customer
Schemas
-
Transaction
-
Client
-
KPI
-
PredictiveKPI
-
CorporateData
-
InvoiceKpi
-
InvoiceRiskAssessment
-
InvoiceBandClassification
-
InvoiceCompanyKpi
-
InvoiceCompanyRiskAssessment
-
InvoiceCompanyBandClassification
-
InvoiceSuggestedLoan
-
InvoiceSuggestedLoanAllocation
-
InvoiceSuggestedLoanSummary
-
TransactionCostType
-
TransactionWithMerchant
-
PagedTransactionsCostType
-
PagedTransactionsWithMerchant
-
Error
-
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_body
-
inline_response_200_21
-
inline_response_400_4
-
inline_response_409
-
inline_response_500_2
-
categorisechequedeposits_body
-
inline_response_200_22
-
inline_response_400_5
-
inline_response_500_3
-
categorisepartnertransactions_body
-
inline_response_400_6
-
assigncategory_body
-
loglending_body
-
inline_response_200_23
-
inline_response_200_24
-
invoiceextractupload_body
-
inline_response_200_25
-
inline_response_400_7
-
inline_response_500_4
-
inline_response_200_26
-
startinvoiceextraction_body
-
inline_response_200_27
-
inline_response_400_8
-
inline_response_500_5
-
inline_response_200_14_transactions
Routing
Open in Explore
Generate Code