Checkpoint Types
LinkedIn may present different types of checkpoints during authentication. Here’s how to handle each one:IN_APP_VALIDATION
- Mobile App Approval
The user must approve the login in their LinkedIn mobile app.
For
IN_APP_VALIDATION
checkpoints:- User Action: The user must approve the login in their LinkedIn mobile app
- Your Action: Poll this endpoint with an empty request body
{}
- Timing: Check every 5-10 seconds with a maximum timeout of 5 minutes
- Completion: Stop when you receive a success response or permanent error
2FA
- Two-Factor Authentication
Two-factor authentication via authenticator app.
- Action: Provide the 6-digit code from the user’s authenticator app
- Timing: Codes expire quickly, so prompt users to provide them promptly
- Request: Send the code in the request body:
{"code": "123456"}
OTP
- One-Time Password (SMS)
One-time password sent via SMS to the user’s phone number.
- Action: Provide the SMS code sent to the user’s phone
- Timing: Codes typically expire within 10-15 minutes
- Request: Send the code in the request body:
{"code": "123456"}
EMAIL
- Email Verification
Verification code sent to the user’s email address.
- Action: Provide the code sent to the user’s registered email
- Note: Check spam/junk folders if the email doesn’t arrive
- Request: Send the code in the request body:
{"code": "123456"}
PHONE_REGISTER
- Phone Number Verification
Phone number verification required by LinkedIn.
- Action: User needs to verify their phone number with LinkedIn
- Note: May require providing a new phone number or confirming existing one
- Request: Send any required verification code:
{"code": "123456"}
CAPTCHA
- Visual/Audio Challenge
Visual or audio challenge to prove human interaction.
- Action: LinkedIn’s automated system will attempt to solve this
- Note: May take time and could fail - retry the authentication if needed
- Request: Usually no code required, but may need to retry the original authentication
LOGIN_FORM
- Additional Login Fields
Additional login form fields required by LinkedIn.
- Action: LinkedIn may request additional information (security questions, etc.)
- Note: Contact support if this checkpoint type is encountered
- Request: Contact support with the
identity_uid
for assistance
UNKNOWN
- Unrecognized Checkpoint
Unrecognized checkpoint type.
- Action: Contact support with the
identity_uid
for assistance - Note: This may indicate a new checkpoint type that needs to be handled
Request Examples
For checkpoint types requiring codes:IN_APP_VALIDATION
checkpoints:
Error Handling
IN_APP_CHALLENGE_PENDING
: Continue polling forIN_APP_VALIDATION
checkpointsIN_APP_CHALLENGE_EXPIRED
: Restart the authentication process2FA_VALIDATION_EXPIRED
: Restart the authentication processCHECKPOINT_MISSING_DATA
: Restart the authentication processINVALID_CODE
: The provided code is incorrect, try again
Authorizations
API key required for authentication. Add your API key in the X-API-Key header.
Path Parameters
Body
application/json
Response
Successfully created a new account.
Available options:
VALID
, INVALID
, PENDING
, LIMIT_REACHED
Available options:
BASIC
, OAUTH
, COOKIES
, APIKEY
Available options:
MANUAL
, EXTENSION
, SHARED
, API