API Reference

Build with Evaaluate.

Full REST API for creating valuations, managing assumptions, and downloading reports programmatically.

Quickstart

1. Authenticate

Ask a firm admin to mint an API token under Settings → API Tokens, then send it as a Bearer token on every request.

2. Create Engagement

POST to /api/v1/engagements with target entity, CIN, and statute. Upload documents.

3. Download Report

Poll report status. When ready, GET the download URL and retrieve the certified report.

# Create a valuation engagement

curl -X POST https://evaaluate.com/api/v1/engagements \

-H "Authorization: Bearer YOUR_TOKEN" \

-H "Content-Type: application/json" \

-d '{"targetEntity":"Acme Pvt Ltd","statute":"RULE_11UA"}'

Endpoints

OpenAPI Spec (JSON)

GET/api/v1/healthHealth check with database connectivity status

GET/api/v1/engagementsList all engagements with optional status filter

POST/api/v1/engagementsCreate a new valuation engagement

GET/api/v1/engagements/:idGet engagement details including assumptions and report status

GET/api/v1/engagements/:id/assumptionsGet current assumptions for an engagement

POST/api/v1/engagements/:id/assumptions/lockLock assumptions and trigger computation (Gate 1)

GET/api/v1/engagements/:id/report/statusCheck report generation status and download URL

POST/api/v1/paymentsCreate a Razorpay payment order for an engagement

POST/api/v1/payments/verifyVerify payment signature after Razorpay checkout

GET/api/v1/teamList team members in your firm

POST/api/v1/team/inviteInvite a new team member (Admin only)

Authentication

Machine callers authenticate with a firm API token (format evk_…). Firm admins mint and revoke tokens via POST /api/v1/settings/api-tokens — the full token is shown exactly once, only its SHA-256 is stored, and it acts with Valuer privileges scoped to your firm.

Include it in the Authorization header: Authorization: Bearer evk_YOUR_TOKEN. Browser sessions (JWT cookies) also work for the same endpoints.

Webhooks

Receive real-time notifications when engagement status changes. Configure webhook URLs in your Settings.

engagement.stage_changed

engagement.gate_pending

engagement.completed

payment.captured

Get API Access