Skip to main content
POST
/
v2
/
login
Connect Account
curl --request POST \
  --url https://api.example.com/v2/login \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "platform": "<string>",
  "email": "<string>",
  "password": "<string>",
  "login_token": "<string>",
  "country": "<string>",
  "account_name": "<string>",
  "challenge_type": "<string>"
}
'
{
  "success": true,
  "data": {
    "account_id": "69c127c37cae0494dd827286",
    "platform": "linkedin",
    "status": "connected"
  },
  "metadata": {
    "action": "login",
    "credits_consumed": 1,
    "timestamp": "2025-01-15T10:30:00.000000"
  }
}
Connect a new channel account (LinkedIn, WhatsApp, etc.) to your API key. Once connected, you receive an account_id to use in all subsequent requests.
This endpoint costs 1 credit per request.

​
Header Parameters

​
x-api-key
string
required
Your API key

​
Body Parameters

​
platform
string
required
The channel platform to connect. Available: linkedin, whatsapp (more coming soon)
​
email
string
Account email address (required for credential-based login)
​
password
string
Account password (required for credential-based login)
​
login_token
string
Authentication token/cookie for direct token-based connection. Alternative to email+password.
​
country
string
default:"FR"
Country code for proxy selection. Available: US, UK, FR, DE, NL, IT, IL, CA, BR, ES, IN
​
account_name
string
Optional display name for the account. Defaults to the email address.
​
challenge_type
string
default:"code_challenge"
Type of 2FA challenge to use if the account has two-factor authentication enabled.
  • code_challenge — receive a verification code via email, SMS, or authenticator app. You must then submit the code via /v2/checkpoint.
  • app_challenge — confirm the login directly from the LinkedIn mobile app. No code needed — just call /v2/checkpoint with the account_id after approving on the app.

​
Response

​
success
boolean
Whether the request was successful
​
data
object
{
  "success": true,
  "data": {
    "account_id": "69c127c37cae0494dd827286",
    "platform": "linkedin",
    "status": "connected"
  },
  "metadata": {
    "action": "login",
    "credits_consumed": 1,
    "timestamp": "2025-01-15T10:30:00.000000"
  }
}

​
Login Methods

There are two ways to connect an account:
  1. Credential-based login — provide email + password. If 2FA is enabled, you’ll receive a checkpoint_required status and need to call /v2/checkpoint.
  2. Token-based login — provide a login_token directly. The token is encrypted and stored securely. No 2FA step needed.

​
Notes

  • The account_id returned is permanent — store it and reuse it for all API calls
  • Tokens are encrypted at rest using AES-256
  • If you receive checkpoint_required, use the /v2/checkpoint endpoint to complete verification
  • The country parameter determines which proxy is used for the connection
  • Each platform may require different parameters (e.g. WhatsApp uses phone_number)