auth.intent
Start a credential/cookie authentication.
Prerequisites
- A Curviate API key, passed as
apiKeywhen you construct the client. Authentication and accounts shows how to create one.
Signature
intent(body: AuthIntentBody): Promise<AuthIntentResult>Example
import { Curviate } from "@curviate/sdk";
const curviate = new Curviate({
apiKey: "cvt_live_...",
baseUrl: "https://api.curviate.com",
});
const result = await curviate.auth.intent({ auth_method: "credentials", credentials: { email: "YOUR_EMAIL", password: "YOUR_PASSWORD" } });
console.log(result.account_id);Parameters
| Name | Type | Required | Description |
|---|---|---|---|
seat_id | string | No | The empty seat this NEW account will occupy. Required on a new connect; omit it and the call returns 400 INVALID_REQUEST with 'seat_id is required'. Seat ids look like seat_01H..., and every seat you own is listed with click-to-copy in the seat table on your dashboard; any seat showing no attached account is free to use. Ignored when account_id is present, because a reconnect keeps the account on its current seat. |
auth_method | string | Yes | How to authenticate. 'credentials' reads the nested credentials object (email + password). 'cookie' reads the nested cookie object (li_at) and also requires a top-level user_agent. Neither set of fields is accepted at the top level. |
credentials | object | No | Email + password authentication, supplied as a NESTED object (email and password do not go at the top level). Required when auth_method=credentials. |
cookie | object | No | Session-cookie authentication, supplied as a NESTED object (li_at does not go at the top level). Required when auth_method=cookie, which also requires a top-level user_agent. |
account_id | string | No | Present = re-authenticate this existing account in place (reconnect); omit = connect a new account. |
trial_premium | string | No | Free-trial seats only: which premium to enable for the trial (at most one). Ignored for paid seats. Defaults to none. |
country | string | No | Managed proxy location hint as an ISO 3166-1 alpha-2 country code (e.g. US, DE). |
ip | string | No | IPv4 address used to infer the managed proxy location. |
proxy | object | No | Managed-proxy egress configuration for this account's outbound traffic. |
user_agent | string | No | Exact browser User-Agent to pin for this account. REQUIRED for a cookie connect: send the User-Agent of the browser the li_at cookie was copied from. Optional for a credentials connect, where it helps an account that hits disconnection issues. |
sync_limit | object | No | Optional caps on how much history is synced for this account. |
recruiter_contract_id | string | No | Which Recruiter contract to bind this account to (Recruiter tier only). |
Returns
Resolves to AuthIntentResult. Top-level fields: object, account_id, status.
Error codes
| Code | What it means, and what to do |
|---|---|
UNAUTHORIZED | The API key is missing, malformed, or revoked. Check the key you passed to the client. |
INVALID_REQUEST | A parameter failed validation. The message names the offending field; fix the request rather than retrying it. |
RATE_LIMIT_ACCOUNT | This account's own quota is exhausted. Wait for the window in the Retry-After header, then retry. |
RATE_LIMIT_TENANT | The tenant-wide quota is exhausted across all accounts. Slow the whole workload, not just this call. |
PLATFORM_RATE_LIMIT | LinkedIn is throttling this account. Back off well beyond the hinted delay; sustained pressure risks the account. |
PLATFORM_ERROR | A transient upstream failure. Retry once with backoff before treating it as a real error. |
CHECKPOINT_ALREADY_RESOLVED | The challenge is already solved. Poll for the account's status instead. |
CHECKPOINT_EXPIRED | The challenge timed out. Request a fresh one and solve it promptly. |
CHECKPOINT_INVALID_CODE | The code was wrong. Ask the account owner for the current one and resubmit. |
CHECKPOINT_MAX_ATTEMPTS | Too many wrong codes. Restart the connect flow from the beginning. |
CHECKPOINT_NOT_FOUND | No challenge is pending for that account. Start the connect flow again. |
CHECKPOINT_UNSUPPORTED | This challenge type cannot be solved through the API. Sign in on LinkedIn directly first. |
CONNECTION_IN_PROGRESS | A connection attempt for this LinkedIn account is already open. Wait for it to finish or expire before starting another. |
LINKEDIN_AUTH_FAILED | LinkedIn rejected the credentials. Confirm them with the account owner. |
LINKEDIN_COOKIE_INVALID | The session cookie is expired or invalid. Supply a fresh one, or connect with credentials. |
LINKEDIN_RATE_LIMITED | LinkedIn is rate limiting the sign-in itself. Wait substantially longer before retrying. |
LINKEDIN_SERVICE_UNAVAILABLE | LinkedIn is unavailable, or the resource is still being prepared upstream. Retry with backoff. |
PAYMENT_REQUIRED | The tenant has no active subscription. Subscribe, then retry. |
PREMIUM_CONFLICT | LinkedIn allows only one individual Premium subscription per profile. Use a second seat, or pair the enable with a disable in the same call. |
REAUTH_REQUIRED | A cookie replay cannot change an account's scope. Re-authenticate with credentials instead. |
Every code above is a stable CurviateError.code you can branch on. The full list, the response envelope, and retry semantics are in the Error codes reference.
Next steps
- Authentication and accounts: connect a LinkedIn account. An empty account list means the key works and nothing is connected yet.
auth.getSession: Poll a credential connect session by its account id, a pure status read that makes no external call and does not itself complete the connection.auth.pollCheckpoint: Poll for mobile-app approval of a pending checkpoint challenge until it leaves pending.- SDK Quick Start: installation, the client, account scoping, and pagination.