SolutionsIndustriesCase StudiesBlogContact UsAbout UsGet Started
</> Developer Reference

API Reference

Integrate Aivance AI capabilities directly into your applications. RESTful APIs with OAuth 2.0 authentication, JSON responses, and enterprise-grade reliability.

Base URL
api.aivancedigital.com
Auth
OAuth 2.0 Bearer
Format
JSON / multipart
TLS
TLS 1.3 required
Versioning
URL path (/v1/)

Authentication

All API requests require a valid Bearer token in the Authorization header. Obtain tokens via the /v1/auth/token endpoint using your Client ID and Secret from the Aivance Developer Portal. Tokens expire after 3,600 seconds — implement automatic refresh in production.

Rate limits: 1,000 req/min (Starter) · 10,000 req/min (Growth) · Unlimited (Enterprise with dedicated capacity)

Endpoints

POST/v1/auth/tokenAuthentication

Exchange client credentials for a bearer access token using OAuth 2.0 Client Credentials flow.

Parameters
grant_typestringrequired
Must be client_credentials
client_idstringrequired
Your API client ID from the Aivance portal
client_secretstringrequired
Your API client secret (treat like a password)
scopestringoptional
Space-separated list of requested scopes
curl -X POST https://api.aivancedigital.com/v1/auth/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET" \
  -d "scope=read:properties write:recommendations"
GET/v1/propertiesReal Estate

Retrieve a paginated list of properties in your portfolio with AI-enriched valuation data and market signals.

Parameters
limitintegeroptional
Results per page, 1–100. Default: 20
pageintegeroptional
Page number for pagination. Default: 1
citystringoptional
Filter by city name (e.g., Mumbai, Bengaluru)
typestringoptional
Property type: residential | commercial | industrial
min_valueintegeroptional
Minimum AI valuation in INR
max_valueintegeroptional
Maximum AI valuation in INR
curl -X GET "https://api.aivancedigital.com/v1/properties?limit=20&city=Mumbai&type=residential" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-Org-ID: your-organisation-id"
POST/v1/properties/valuateReal Estate

Request an instant AI valuation for a new property. Returns valuation with confidence score, comparables, and market context.

Parameters
addressstringrequired
Full property address including city and PIN code
area_sqftnumberrequired
Built-up area in square feet
typestringrequired
residential | commercial | industrial | plot
floorintegeroptional
Floor number (influences high-rise premium)
bedroomsintegeroptional
Number of bedrooms (residential only)
amenitiesarrayoptional
List of amenities: parking, gym, pool, security, etc.
curl -X POST https://api.aivancedigital.com/v1/properties/valuate \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "address": "Block 4, Hiranandani Gardens, Powai, Mumbai 400076",
    "area_sqft": 1800,
    "type": "residential",
    "floor": 12,
    "bedrooms": 3,
    "amenities": ["parking", "gym", "pool"]
  }'
POST/v1/recommendationsAI Recommendations

Generate contextual AI recommendations for a given entity and use-case. Supports real estate, healthcare, and enterprise recommendation types.

Parameters
typestringrequired
portfolio_optimisation | property_match | patient_pathway | workflow_automation
entity_idstringrequired
ID of the portfolio, patient, or workflow to analyse
contextobjectoptional
Domain-specific context parameters (see type docs)
max_resultsintegeroptional
Maximum recommendations to return (1–20). Default: 3
curl -X POST https://api.aivancedigital.com/v1/recommendations \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "portfolio_optimisation",
    "entity_id": "portfolio_98ab12",
    "context": {
      "investment_horizon": "5y",
      "risk_profile": "moderate",
      "current_yield_pct": 4.2,
      "target_yield_pct": 6.5
    },
    "max_results": 5
  }'
POST/v1/documents/extractDocument AI

Extract structured data from unstructured documents — contracts, invoices, clinical notes, regulatory filings — using Aivance multi-modal AI.

Parameters
filefilerequired
Document file: PDF, DOCX, PNG, JPEG (max 50MB)
schemastringoptional
invoice | contract | clinical_note | regulatory | auto. Default: auto
languagestringoptional
ISO 639-1 language code. Default: auto-detect
curl -X POST https://api.aivancedigital.com/v1/documents/extract \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -F "file=@invoice_Q2_2026.pdf" \
  -F "schema=invoice" \
  -F "language=en"

Ready to start building?

Get your API credentials from the Aivance Developer Portal. Sandbox access is available instantly on all plans.

Get API AccessContact Developer Support