Get a connect session's status

Returns a credential connect session's status by account id (from auth/intent or a checkpoint). status is checkpoint_required, done, expired, or failed; checkpoint_required carries challenge_type. Poll until status leaves checkpoint_required.

get/v1/auth/sessions/{session_id}

Request

Base URL: https://api.curviate.com
URL: https://api.curviate.com/v1/auth/sessions/{session_id}
Auth: HTTP bearer

Path parameters

session_idstring required

The credential account id (acc_...) returned by auth/intent or a checkpoint response, the handle for the in-progress connect.

Response

The current status of a credential connect session (acc_... id from auth/intent or a checkpoint response). Poll until status leaves checkpoint_required. account_id is present only once status is done. checkpoint_required carries challenge_type, the challenge still pending. failed carries no reason payload.

object'auth_session'

Response type discriminator.

session_idstring

The account id polled (acc_...).

status'checkpoint_required' | 'done' | 'expired' | 'failed'

Lifecycle status. checkpoint_required (a challenge is pending, carries challenge_type) / done (connected) / expired (timed out) / failed (terminal failure).

account_idstring nullable

The connected account (acc_...); null until status is done.

challenge_typestring

The pending challenge type. Present in checkpoint_required.

expires_atstring nullable

ISO-8601 UTC challenge expiry, when known; null otherwise.

Example response

{
  "safety_warning": {
    "row": "profile_views",
    "reset_at": "2026-09-05T00:00:00.000Z",
    "hint": {
      "parameter": "profile_views.ceiling",
      "message": "This account is at its ceiling for profile_views. This action went through because profile_views.posture is warn, and it counted: 101 of 100 this window. Raise profile_views.ceiling, or wait for the window to reset at 2026-09-05T00:00:00.000Z."
    },
    "reason": "ceiling",
    "blocked": false
  }
}

Changes

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