Skip to main content
GET
/
scanner
/
api
/
v1
/
sessions
/
{id}
/
status
Poll session status
curl --request GET \
  --url https://www.closient.com/scanner/api/v1/sessions/{id}/status \
  --header 'X-API-Key: <api-key>'
{
  "captures": [
    {
      "proposal_count": 0
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
id
string<shortuuid>
required

Unique session id identifier.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Response

200 - application/json

OK

Lightweight session status for polling completion.

​
session_status
enum<string>
required

Lifecycle state of the session — same set as SessionResponseSchema.status. Polling clients should treat any value other than ACTIVE as terminal.

Available options:
ACTIVE,
COMPLETED,
EXPIRED
​
extraction_status
enum<string>
required

Vision-extraction pipeline stage. pending before submit; processing while Bedrock runs; ready once results are available for review; accepted / rejected after the operator reviews them.

Available options:
pending,
processing,
ready,
accepted,
rejected
​
captures
CaptureStatusSchema · object[]

Status of each capture.