API Reference

The Command API provides a RESTful interface for lenders to push account and borrower data into the Command platform, manage account statuses, and keep portfolios in sync.

Base URLs

Production
Staging

Purpose	URL
Authentication	`https://v3-api.cleargrid.ai/`
Account Management	`https://v3-api.cleargrid.ai/admin/v3`
CRM Dashboard	`https://command.cleargrid.ai/`

Purpose	URL
Authentication	`https://stage-v3-api.cleargrid.ai/`
Account Management	`https://stage-v3-api.cleargrid.ai/admin/v3`
CRM Dashboard	`https://staging.cleargrid.ai/`

Always use the Staging environment for development and testing. Only switch to Production when you are ready to go live with real data.

Authentication

All API requests (except login) require a valid Bearer token in the Authorization header. Tokens are obtained through the Lender Login endpoint and can be refreshed using the Refresh Token endpoint.

curl -X POST https://v3-api.cleargrid.ai/admin/v3/lenders/{lenderPublicId}/accounts \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{ "accounts": [...] }'

Your lender credentials (email, password, and lender identifier) will be provided by ClearGrid during onboarding. Store them securely and never expose them in client-side code.

HTTP Status Codes

Status Code	Description
`200`	OK — Request succeeded. Data accepted and processing has started in the background.
`400`	Bad Request — The request body contains validation errors. Check the `errors` array for details.
`401`	Unauthorized — Missing, invalid, or expired authentication token.
`500`	Internal Server Error — Something went wrong on our end. Contact support if this persists.

API Endpoints

Authentication

Authenticate with lender credentials to obtain access tokens for API requests.

Accounts

Create, update, and withdraw accounts and sub-accounts. Manage your portfolio programmatically.

Need Help?

Our support team is available Monday-Friday, 9 AM - 6 PM GST. Reach out at support@cleargrid.com or visit our help center.

Getting Started

Authentication

Accounts

Exports

Base URLs

Authentication

HTTP Status Codes

API Endpoints

Authentication

Accounts

Need Help?

​Base URLs

​Authentication

​HTTP Status Codes

​API Endpoints

Authentication

Accounts

Need Help?

Base URLs

Authentication

HTTP Status Codes

API Endpoints