Getting Started with Thrive Public API

Welcome to the Thrive Public API documentation! This API enables partners to integrate loan application management, funding requests, and project completion workflows into their systems.

Quick Start

1. Obtain API Credentials

Contact your Thrive integration manager to receive:

• Client ID - Your unique API client identifier
• Client Secret - Your secret key for authentication
• Merchant UID - Your ID in our system - must be associated with client ID and secret in a group; otherwise, it is not required.
• Environment URLs - Sandbox and production endpoints

2. Authentication

All API requests two specific headers that will be provided to you by thrive: x-thrive-client-id and x-thrive-secret-id.

Example request

curl --location 'https://api.partnerwiththrive.com/public/example' \
  -H "Content-Type: application/json" \
  --header 'x-thrive-client-id': 'xxxxxxxxxx' \
  --header 'x-thrive-client-secret': 'xxxxxxxxxx' \
  --data '{}'

Environments

Common Workflows

Loan Application Process

1. Create Application → POST /application
2. Run Decision → POST /application/create-run-decision
3. Request Draw → POST /loan/{uid}/request-draw
4. Upload Completion → POST /loan/{uid}/completion-cert-upload

Error Handling

All endpoints return standardized error responses:

{
  "timestamp": "2024-01-15T10:30:00.000Z",
  "statusCode": 400,
  "result": {
    "data": null,
    "error": {
      "message": "Invalid request parameters",
      "code": "VALIDATION_ERROR"
    }
  }
}

🚨

Complete Error Handling Guide

For comprehensive error handling documentation including all error codes, best practices, and retry logic implementation, see our Error Handling guide.

Ready to get started? Check out our API Reference for detailed endpoint documentation.