Skip to content

Quick Start

Get started with the FairFigure Ingest API in minutes.

Prerequisites

Before you begin, ensure you have:

  • A FairFigure Partner API key
  • HTTPS client capability (cURL, Postman, or your preferred HTTP library)

Making Your First Request

1. Set up authentication

Include your API key in the request headers:

sh
Authorization: Bearer YOUR_API_KEY

2. Prepare your payload

Create a JSON payload with the required fields:

json
{
  "email": "[email protected]",
  "business_name": "Acme Corp",
  "ein": "123456789"
}

3. Send the request

Make a POST request to the ingest endpoint:

sh
curl -X POST https://fairfigue.com/api/v1/capital/ingest \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "business_name": "Acme Corp",
    "ein": "123456789"
  }'

4. Handle the response

A successful response will include a FairFigure ID:

json
{
  "message": "Application processed successfully. User will receive login instructions via email within a few minutes.",
  "data": {
    "fundex_id": "FFASD123K"
  }
}

What's Next?

Now that you've made your first request, explore the detailed guides: