Orbii Risk Assessment API
The Risk Assessment API from Orbii — 5 operation(s) for risk assessment.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/orbii-risk-assessment-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Orbii KSA Business Category Assignment Risk Assessment API
description: API for managing transactions, clients, and companies.
version: 1.0.3
servers:
- url: https://api.sa.orbii.ai/
description: Production server
tags:
- name: Risk Assessment
paths:
/risk_assessment/customer/{customer_id}:
get:
summary: Get risk assessment for a specific customer
description: Returns a list of risk assessment rules and scores for the specified customer.
tags:
- Risk Assessment
parameters:
- name: customer_id
in: path
required: true
description: The unique customer identifier (GUID).
schema:
type: string
- name: user
in: query
required: false
description: Database username (optional if set via environment variables).
schema:
type: string
- name: password
in: query
required: false
description: Database password (optional if set via environment variables).
schema:
type: string
responses:
'200':
description: Successful response with risk assessment results
content:
application/json:
schema:
type: array
items:
type: object
properties:
category:
type: string
rule:
type: string
value:
type: string
assessment:
type: string
customer_id:
type: string
'500':
description: Internal server error
/band_classification/customer/{customer_id}:
get:
summary: Get band classification for a specific customer
description: Returns the band classification, component scores, score values, total score, and red flag reason for the specified customer.
tags:
- Risk Assessment
parameters:
- name: customer_id
in: path
required: true
description: The unique customer identifier (GUID).
schema:
type: string
- name: user
in: query
required: false
description: Database username (optional if set via environment variables).
schema:
type: string
- name: password
in: query
required: false
description: Database password (optional if set via environment variables).
schema:
type: string
responses:
'200':
description: Successful response with band classification results
content:
application/json:
schema:
type: array
items:
type: object
properties:
baseline_eligibility_score:
type: number
revenue_and_income_score:
type: number
expenses_and_profitability_score:
type: number
loan_and_debt_management_score:
type: number
cash_flow_and_liquidity_score:
type: number
business_liquidity_and_stability_score:
type: number
bank_account_balance_score:
type: number
baseline_eligibility_score_value:
type: number
revenue_and_income_score_value:
type: number
expenses_and_profitability_score_value:
type: number
loan_and_debt_management_score_value:
type: number
cash_flow_and_liquidity_score_value:
type: number
business_liquidity_and_stability_score_value:
type: number
bank_account_balance_score_value:
type: number
total_score:
type: number
band:
type: string
red_flag_reason:
type:
- string
- 'null'
'500':
description: Internal server error
/update-kpi-rule:
post:
summary: Update a KPI rule threshold
description: Updates a KPI rule threshold.
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
type: object
required:
- category
- rule
- new_threshold
properties:
category:
type: string
rule:
type: string
new_threshold:
type: integer
user:
type: string
password:
type: string
tags:
- Risk Assessment
responses:
'200':
description: KPI rule updated successfully
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: KPI rule updated successfully
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: 'Missing required parameters: category, rule, new_threshold'
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: Something went wrong
/rerun-assessment:
post:
summary: Reruns Assessment
tags:
- Risk Assessment
description: Triggers the pipeline to rerun the assessment.
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
user:
type: string
example: user
password:
type: string
example: password
required:
- user
- password
responses:
'200':
description: Successfully triggered Assessment pipeline
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Assessment pipeline triggered successfully
'400':
description: Missing required parameters
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: 'Missing required parameters: user and password'
'500':
description: Failed to trigger pipeline
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: Pipeline trigger failed
response_text:
type: string
example: Error details
/band_classification:
get:
summary: Get band classification for all customers
description: 'Returns band classification scores, values, total score, band, and red flag reasons for all customer IDs.
'
tags:
- Risk Assessment
parameters:
- in: query
name: user
schema:
type: string
required: true
description: Database username.
- in: query
name: password
schema:
type: string
required: true
description: Database password.
responses:
'200':
description: A list of band classifications for all customers.
content:
application/json:
schema:
type: array
items:
type: object
properties:
customer_id:
type: string
example: 43d027ff-e6cc-4f77-ab7a-1a8f34259035
baseline_eligibility_score:
type: number
example: 85
revenue_and_income_score:
type: number
example: 90
expenses_and_profitability_score:
type: number
example: 70
loan_and_debt_management_score:
type: number
example: 80
cash_flow_and_liquidity_score:
type: number
example: 75
business_liquidity_and_stability_score:
type: number
example: 88
bank_account_balance_score:
type: number
example: 82
baseline_eligibility_score_value:
type: integer
example: 1
revenue_and_income_score_value:
type: integer
example: 1
expenses_and_profitability_score_value:
type: integer
example: 0
loan_and_debt_management_score_value:
type: integer
example: 1
cash_flow_and_liquidity_score_value:
type: integer
example: 0
business_liquidity_and_stability_score_value:
type: integer
example: 1
bank_account_balance_score_value:
type: integer
example: 1
total_score:
type: number
example: 497
band:
type: string
example: A
red_flag_reason:
type:
- string
- 'null'
example: High loan default risk
'400':
description: Missing or invalid parameters
'500':
description: Internal server error