Getting started

Learn how to authenticate and make your first API call to Stacked.

Prerequisites

Before you begin

Make sure you have the following:

  • A Stacked account with API access enabled (contact your account manager)
  • An API key generated from your lender portal
  • HTTP client (curl, Postman, or your preferred programming language)

Endpoint

Stacked's REST API endpoint is:

https://api.growstacked.com/api/v1

All API requests should be made to this base URL.

Authentication

The Stacked API supports API key authentication.

API Key Header

Include your API key in the X-API-Key header:

X-API-Key: sk_tenant_yourcode_abc123...

Getting Your API Key

  1. Log in to your Stacked lender portal
  2. Navigate to Organization → Security → API Keys
  3. Click "Create API Key" and give it a descriptive name
  4. Copy the key immediately (you won't be able to see it again)
  5. Store it securely - never commit API keys to version control

Your First API Call

Let's create your first application via the API.

Create an Application

Use the POST endpoint to create a new application. Field names use apiName values from your tenant's questionsConfig:

curl -X POST https://api.growstacked.com/api/v1/applications \
  -H "X-API-Key: sk_tenant_yourcode_abc123..." \
  -H "Content-Type: application/json" \
  -d '{
    "email": "applicant@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "phone": "+15551234567",
    "requestAmount": 50000,
    "businessName": "Acme Corp"
  }'

Note: Field names like requestAmount and businessName are defined in your tenant's questionsConfig. Contact your account manager for your available field names.

Response

On success, you'll receive a 201 response with the application details:

{
  "applicationId": "550e8400-e29b-41d4-a716-446655440000",
  "code": 12345,
  "status": "DRAFT"
}

Next Steps

Continue Learning