Resources

OpenAPI Specification

Machine-readable API specification for code generation and tooling

The SmartMCA Public API provides an OpenAPI 3.0 specification that you can use for code generation, Postman import, automated testing, and building client SDKs.

Download

Format	Link
JSON	/openapi/smartmca-v1.json

Endpoints Covered

The spec includes all 77 endpoints across 14 resource groups:

Resource	Endpoints	Description
Deals	6	CRUD + status updates
Applications	4	Pipeline management
Merchants	4	Merchant profiles
Contacts	5	Merchant contacts
Payments	3	Deal payment transactions
Documents	3	Document management
Collections	1	Collection schedules
Analysis	5	SmartScrub bank statement & transaction analysis
Underwriting	6	Deal-scoped underwriting tools
Accounting	16	Chart of accounts, entries, reports
Deal Accounting	2	Deal-scoped entries & revenue
Workflows	8	Workflow orchestration + application actions
Webhooks	9	Subscription management & delivery
Infrastructure	2	Health check & echo

Import into Postman

1. Open Postman
2. Click Import (top left)
3. Select the Link tab
4. Paste: https://developers.smartmca.com/openapi/smartmca-v1.json
5. Click Import
6. Set the api_key variable to your API key

Or use the pre-built Postman collection — see Postman Collection.

Code Generation

Use the OpenAPI spec with any code generator:

# TypeScript client
npx openapi-typescript-codegen \
  --input https://developers.smartmca.com/openapi/smartmca-v1.json \
  --output ./src/api

# Python client
openapi-python-client generate \
  --url https://developers.smartmca.com/openapi/smartmca-v1.json

# C# client (NSwag)
nswag openapi2csclient \
  /input:https://developers.smartmca.com/openapi/smartmca-v1.json \
  /output:SmartMcaClient.cs

Interactive Viewer

View the spec interactively with Redocly or Swagger UI:

# Redocly (recommended)
npx @redocly/cli preview-docs openapi/smartmca-v1.json

# Swagger UI via Docker
docker run -p 8080:8080 \
  -e SWAGGER_JSON=/spec/smartmca-v1.json \
  -v $(pwd)/public/openapi:/spec \
  swaggerapi/swagger-ui

Updating the Spec

The spec is maintained in docs-site/public/openapi/smartmca-v1.json. To regenerate from a running backend:

cd docs-site
npx tsx scripts/export-openapi.ts          # auto-detect backend
npx tsx scripts/export-openapi.ts --local  # force fetch from backend
npx tsx scripts/export-openapi.ts --static # use checked-in spec