Skip to main content

Getting Started

This guide will help you get up and running with the Link Account Manager API quickly and efficiently.

Prerequisites​

Before you begin, make sure you have:

  • Access to the Link Account Manager service
  • API credentials (API key and JWT token)
  • Basic knowledge of REST APIs
  • HTTPS-enabled endpoints for production integrations

Authentication​

All API requests require authentication using API keys and JWT tokens.

API Key Authentication​

Include your API key in the request headers:

X-API-KEY: your_api_key_here
Authorization: Bearer your_jwt_token_here

JWT Token Authentication​

For most endpoints, you'll need both an API key and a JWT token:

curl -X POST <link_account_manager_host>/v1/auth/login \
  -H "X-API-KEY: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "your_email@example.com",
    "password": "your_password"
  }'

Base URLs​

Our services are available at the following base URLs:

  • Production API: <link_account_manager_host>
  • Sandbox API: <link_account_manager_host>/sandbox

Your First API Call​

Let's start with a simple health check to verify your connection:

curl -X GET <link_account_manager_host>/v1/health \
  -H "X-API-KEY: your_api_key"

Expected response:

{
  "status": "App is OK and running"
}

Response Format​

All API responses follow a consistent format:

Successful Response​

{
  // Response data here
}

Error Response​

{
  "statusCode": 400,
  "error": ["id must be a UUID"],
  "requestId": "72e32108-6260-45e9-bb12-325fe3b61e42",
  "path": "/accounts/invalid-id",
  "timestamp": "2025-11-19T16:32:57.915Z"
}

Testing Your Integration​

We provide a comprehensive sandbox environment for testing:

  1. Use sandbox URLs for all testing
  2. Test data is reset daily at midnight UTC
  3. HTTPS endpoints are required for production integrations
  4. API keys for sandbox are separate from production

Next Steps​

Now that you're familiar with the basics:

  1. Explore the API Reference - Learn about available endpoints
  2. Review Error Handling - Handle errors gracefully
  3. Contact Support - Get assistance with your specific integration needs

Need help? Check our FAQ or contact our support team.