PApasito
Benefit Elections

Get a benefit election and its status

get/v1/clients/{clientId}/benefit-elections/{id}

Request

  • Base URL
    https://api.pasito.ai
  • Auth
    HTTP bearer

Path parameters

clientIdstring required

Client id — either a Pasito com_ id (GET /v1/clients) or your own external client id, which Pasito matches on aliasExternalId and creates a client for if it matches none yet.

idstring required

Benefit-election (extraction run) id.

Response

A benefit-election status snapshot — the same shape whether it arrived over the REST API or an SFTP drop.

idstring required

The benefit-election (extraction run) id — poll it for status.

status'requested' | 'in_progress' | 'completed' | 'failed' | 'canceled' required

completed means the election was extracted AND applied — a plan year now exists on the client, hidden from employees pending your audit. failed means Pasito accepted the workbook(s) but extraction or applying them did not produce a plan year (see errorCode).

intakeIdstring required

The election intake record the extraction writes into.

intakeKind'first_setup' | 'renewal' | 'new_client' required

Which kind of election this is.

clientIdstring nullable required

The Pasito company the election landed on, null until applied.

clientRefstring nullable required

The client identifier you supplied — your own external id or the Pasito com_ id.

periodIdstring nullable required

The plan year the election created, null until applied.

deliveredVia'api' | 'sftp' required

Whether the election arrived over the REST API or an SFTP drop.

folderPathstring nullable required

The SFTP drop folder that produced this election, relative to your SFTP home (e.g. /client-benefit-elections/9172/2026-09-28T021533). Null for a REST-initiated election.

errorCodestring nullable required

Machine-readable failure reason, present only when status is failed.

userMessagestring nullable required

Human-readable failure reason, present only when status is failed. Pair with errorCode for programmatic handling; show this to a human.

startedAtstring

When extraction started, as an ISO 8601 timestamp. Absent until it does.

finishedAtstring

When extraction finished, as an ISO 8601 timestamp. Absent until it does.

createdAtstring required

When the election was created, as an ISO 8601 timestamp.

Changes

No recorded changes to this operation across all 1 revision of this API.