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.

Prerequisites

A Curviate API key, passed as apiKey when you construct the client. Quickstart shows how to create one.

Signature

getSession(sessionId: string): Promise<AuthGetSessionResult>

Example

import { Curviate } from "@curviate/sdk";
 
const curviate = new Curviate({
  apiKey: "cvt_live_...",
  baseUrl: "https://api.curviate.com",
});
 
const result = await curviate.auth.getSession("YOUR_SESSION_ID");
console.log(result.session_id);

Parameters

Name	Type	Required	Description
`sessionId`	`string`	Yes	The credential account id (acc_...) returned by auth/intent or a checkpoint response, the handle for the in-progress connect.

Returns

Resolves to AuthGetSessionResult. Top-level fields: object, session_id, status, account_id, challenge_type, expires_at, safety_warning.

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`	An upstream failure, usually transient: retry once with backoff before treating it as a real error. Check the response first, though. When it carries `retry_likely_to_succeed: false` and `retry_hint: {kind: "never"}`, retrying cannot help and backing off only delays the real answer.
`INTERNAL`	An unexpected server error. Retry once; if it persists, it is ours, not yours.
`RESOURCE_NOT_FOUND`	The id in the path does not exist, or is not visible to this account. Re-read it from the list endpoint that produced it.

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

Quickstart: connect a LinkedIn account. An empty account list means the key works and nothing is connected yet.
auth.intent: Authenticate a LinkedIn account with credentials or a session cookie.
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.