Introduction
The RecovAI API lets your own systems work with the same recovery cases your team sees in the RecovAI web app. Use it to:
- Create cases from your servicing or CRM system as soon as an account goes into recovery.
- Upload documents (agreements, bank statements, filings) so RecovAI can read them.
- Run the pipeline that checks readiness, finds targets and prepares a strategy.
- Record recoveries (funds identified, payments, settlements) on the case ledger.
- Keep tasks in sync with your own work queue.
The basics
Section titled “The basics”| Base URL | https://api.recovai.ai |
| Format | JSON request and response bodies (file uploads use multipart/form-data) |
| Authentication | An API key in the X-API-Key header. See Authentication. |
| Scope | Everything a key can see or change belongs to your workspace. |
Key terms
Section titled “Key terms”- Case: one account in recovery. It has a business name, a balance, an owner on your team, documents and a readiness status.
- Account holder: the business (and, where relevant, the individual) responsible for the account.
- Readiness: where the case is in RecovAI’s pipeline, from
drafttosubmittedand beyond. See Cases. - Recovery ledger: the money history of a case: funds identified, payments received, costs and remittances.
What the API does not do
Section titled “What the API does not do”API keys are deliberately limited. They cannot:
- send anything outside RecovAI (letters, emails, secure response rooms, cloud exports);
- approve legal or attorney reviews, or close, reopen or place legal holds on cases;
- change workspace settings, users, integrations or API keys.
Those actions always need a signed-in person in the web app.