Skip to main content
Generate a token to start the account connection flow.
curl -X POST 'https://api.usehandled.io/api/v1/ipaas/link-token' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "tenant_id": "customer-123"
  }'

Parameters

FieldTypeDescription
tenant_idstringYour customer’s identifier
integrated_account_idstringOptional. For reauthorizing existing accounts
integration_namestringOptional. Pre-select a specific integration

Response

{
  "link_token": "abc123-def456-ghi789"
}

Usage Options

Embedded SDK

Use the Link SDK to open a popup:
import authenticate from '@handled/link-sdk';

authenticate('abc123-def456-ghi789')
  .then(response => console.log('Connected:', response))
  .catch(error => console.error('Error:', error));
Generate a shareable URL:
https://ipaas.usehandled.io/connect-account?link_token=abc123-def456-ghi789

Reauthorize Existing Account

Generate a token to refresh credentials for an existing account:
curl -X POST 'https://api.usehandled.io/api/v1/ipaas/link-token' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "integrated_account_id": "acc_456"
  }'

Pre-Select Integration

Direct users to a specific integration:
curl -X POST 'https://api.usehandled.io/api/v1/ipaas/link-token' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "tenant_id": "customer-123",
    "integration_name": "shiphero"
  }'