Skip to main content
POST
/
v2
/
checkpoint
Verify Checkpoint (2FA)
curl --request POST \
  --url https://api.example.com/v2/checkpoint \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "account_id": "<string>",
  "code": "<string>"
}
'
{
  "success": true,
  "data": {
    "account_id": "69c127c37cae0494dd827286",
    "status": "connected"
  },
  "metadata": {
    "action": "checkpoint",
    "credits_consumed": 1,
    "timestamp": "2025-01-15T10:32:00.000000"
  }
}
Complete 2FA verification for an account that returned checkpoint_required during login. Depending on the challenge_type used at login, either submit a verification code or simply confirm the app challenge.
This endpoint costs 1 credit per request.

Header Parameters

x-api-key
string
required
Your API key

Body Parameters

account_id
string
required
The account ID returned from the /v2/login endpoint with checkpoint_required status
code
string
The verification code received via email, SMS, or authenticator app. Required when challenge_type is code_challenge. Not needed for app_challenge — the user approves directly from the LinkedIn app.

Response

success
boolean
Whether the verification was successful
data
object
{
  "success": true,
  "data": {
    "account_id": "69c127c37cae0494dd827286",
    "status": "connected"
  },
  "metadata": {
    "action": "checkpoint",
    "credits_consumed": 1,
    "timestamp": "2025-01-15T10:32:00.000000"
  }
}

Challenge Types

  • code_challenge — The user receives a verification code (email, SMS, or authenticator app). Submit the code in the code field.
  • app_challenge — The user approves the login directly from the LinkedIn mobile app. Once approved, call this endpoint with only the account_id (no code needed).

Notes

  • If the session has expired, you need to call /v2/login again to restart the process
  • Once verified, the account status changes to connected and is ready for use
  • The account_id remains the same — no need to update your integration