Verify Checkpoint (2FA)

curl --request POST \
  --url https://api.linkupapi.com/v2/checkpoint \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "account_id": "<string>",
  "code": "<string>",
  "resend": true
}
'

import requests

url = "https://api.linkupapi.com/v2/checkpoint"

payload = {
    "account_id": "<string>",
    "code": "<string>",
    "resend": True
}
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({account_id: '<string>', code: '<string>', resend: true})
};

fetch('https://api.linkupapi.com/v2/checkpoint', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.linkupapi.com/v2/checkpoint",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'account_id' => '<string>',
    'code' => '<string>',
    'resend' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.linkupapi.com/v2/checkpoint"

	payload := strings.NewReader("{\n  \"account_id\": \"<string>\",\n  \"code\": \"<string>\",\n  \"resend\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.linkupapi.com/v2/checkpoint")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": \"<string>\",\n  \"code\": \"<string>\",\n  \"resend\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.linkupapi.com/v2/checkpoint")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": \"<string>\",\n  \"code\": \"<string>\",\n  \"resend\": true\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "account_id": "69c127c37cae0494dd827286",
    "status": "connected"
  },
  "metadata": {
    "action": "checkpoint",
    "credits_consumed": 1,
    "timestamp": "2025-01-15T10:32:00.000000"
  }
}

{
  "success": true,
  "data": {
    "account_id": "69c127c37cae0494dd827286",
    "status": "code_sent",
    "method": "sms",
    "available_methods": ["sms", "call", "email"],
    "sent_to": "phone number ending with 23",
    "checkpoint_message": "LinkedIn sent a verification code to the phone number ending with 23."
  },
  "metadata": {
    "action": "checkpoint",
    "credits_consumed": 0,
    "timestamp": "2025-01-15T10:31:00.000000"
  }
}

{
  "success": false,
  "error": {
    "code": "CHANNEL_ERROR",
    "message": "Verification failed",
    "sub_code": "CHECKPOINT_VERIFICATION_FAILED"
  },
  "metadata": {
    "action": "checkpoint",
    "credits_consumed": 0,
    "timestamp": "2025-01-15T10:32:00.000000"
  }
}

{
  "success": false,
  "error": {
    "code": "CHANNEL_ERROR",
    "message": "Session expired, please login again",
    "sub_code": "CHECKPOINT_SESSION_EXPIRED"
  },
  "metadata": {
    "action": "checkpoint",
    "credits_consumed": 0,
    "timestamp": "2025-01-15T10:32:00.000000"
  }
}

POST

checkpoint

Verify Checkpoint (2FA)

curl --request POST \
  --url https://api.linkupapi.com/v2/checkpoint \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "account_id": "<string>",
  "code": "<string>",
  "resend": true
}
'

import requests

url = "https://api.linkupapi.com/v2/checkpoint"

payload = {
    "account_id": "<string>",
    "code": "<string>",
    "resend": True
}
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({account_id: '<string>', code: '<string>', resend: true})
};

fetch('https://api.linkupapi.com/v2/checkpoint', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.linkupapi.com/v2/checkpoint",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'account_id' => '<string>',
    'code' => '<string>',
    'resend' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.linkupapi.com/v2/checkpoint"

	payload := strings.NewReader("{\n  \"account_id\": \"<string>\",\n  \"code\": \"<string>\",\n  \"resend\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.linkupapi.com/v2/checkpoint")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": \"<string>\",\n  \"code\": \"<string>\",\n  \"resend\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.linkupapi.com/v2/checkpoint")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": \"<string>\",\n  \"code\": \"<string>\",\n  \"resend\": true\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "account_id": "69c127c37cae0494dd827286",
    "status": "connected"
  },
  "metadata": {
    "action": "checkpoint",
    "credits_consumed": 1,
    "timestamp": "2025-01-15T10:32:00.000000"
  }
}

{
  "success": true,
  "data": {
    "account_id": "69c127c37cae0494dd827286",
    "status": "code_sent",
    "method": "sms",
    "available_methods": ["sms", "call", "email"],
    "sent_to": "phone number ending with 23",
    "checkpoint_message": "LinkedIn sent a verification code to the phone number ending with 23."
  },
  "metadata": {
    "action": "checkpoint",
    "credits_consumed": 0,
    "timestamp": "2025-01-15T10:31:00.000000"
  }
}

{
  "success": false,
  "error": {
    "code": "CHANNEL_ERROR",
    "message": "Verification failed",
    "sub_code": "CHECKPOINT_VERIFICATION_FAILED"
  },
  "metadata": {
    "action": "checkpoint",
    "credits_consumed": 0,
    "timestamp": "2025-01-15T10:32:00.000000"
  }
}

{
  "success": false,
  "error": {
    "code": "CHANNEL_ERROR",
    "message": "Session expired, please login again",
    "sub_code": "CHECKPOINT_SESSION_EXPIRED"
  },
  "metadata": {
    "action": "checkpoint",
    "credits_consumed": 0,
    "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. Ignore this if you’re on per-seat pricing: usage is unlimited.

Also completes an email OAuth connection (Gmail / Microsoft): after the user consents, submit the code (and state) returned to your redirect_uri together with the account_id. See Connect a mailbox.

Recruiter seat: pass the account’s account_id with the code. See Recruiter seat.

Product or contract choice (checkpoint_type product_selection or contract_selection): put the choice in code, e.g. "classic,recruiter" or a contract id. See Choosing products and contracts.

WhatsApp: send only the account_id to get the current QR code, or connected once scanned. resend: true gives a new code once it expired. See Connect Account.

Header Parameters

string

required

Your API key

Body Parameters

string

required

The account ID returned from the /v2/login endpoint with checkpoint_required status

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 platform’s mobile app.checkpoint_type in the login response tells where the code went. Each new /v2/login invalidates the previous code.

boolean

default:"false"

LinkedIn only. Set to true to have LinkedIn send the verification code again on the same channel if the user did not receive it. No code needed, no credit consumed — then call this endpoint again with the code.

Response

boolean

Whether the verification was successful

object

Show Properties

string

The account ID, now fully connected

string

connected — the account is ready to use

{
  "success": true,
  "data": {
    "account_id": "69c127c37cae0494dd827286",
    "status": "connected"
  },
  "metadata": {
    "action": "checkpoint",
    "credits_consumed": 1,
    "timestamp": "2025-01-15T10:32:00.000000"
  }
}

{
  "success": true,
  "data": {
    "account_id": "69c127c37cae0494dd827286",
    "status": "code_sent",
    "method": "sms",
    "available_methods": ["sms", "call", "email"],
    "sent_to": "phone number ending with 23",
    "checkpoint_message": "LinkedIn sent a verification code to the phone number ending with 23."
  },
  "metadata": {
    "action": "checkpoint",
    "credits_consumed": 0,
    "timestamp": "2025-01-15T10:31:00.000000"
  }
}

{
  "success": false,
  "error": {
    "code": "CHANNEL_ERROR",
    "message": "Verification failed",
    "sub_code": "CHECKPOINT_VERIFICATION_FAILED"
  },
  "metadata": {
    "action": "checkpoint",
    "credits_consumed": 0,
    "timestamp": "2025-01-15T10:32:00.000000"
  }
}

{
  "success": false,
  "error": {
    "code": "CHANNEL_ERROR",
    "message": "Session expired, please login again",
    "sub_code": "CHECKPOINT_SESSION_EXPIRED"
  },
  "metadata": {
    "action": "checkpoint",
    "credits_consumed": 0,
    "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 platform’s 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

Getting Started

Accounts

Profiles

Messaging

Network

Content

Recruiting

Credits

Logs

Email Enrichment

Webhooks (Real-Time)

Verify Checkpoint (2FA)

Header Parameters

Body Parameters

Response

Challenge Types

Notes