v1

latestOpenAPI 3.1.12026-07-124448163.2 KB

collect.sessions

Complete collect session

Marks the session as completed by the client, optionally with a note about missing documents.

post/collect/sessions/{token}/complete

Path parameters

tokenstring required

The session token

Example:cs_live_cmll8jh7b00013b6tlu7lvntw

Request body

clientNotestring

outcome'complete' | 'incomplete' | 'incomplete_finished'

Explicit completion outcome picked by the client: 'complete' (everything provided), 'incomplete' (will provide the rest later), 'incomplete_finished' (cannot provide the rest; clientNote explains).

Example request

{
  "outcome": "complete"
}

Response

Session completed

successboolean required

Example response

{
  "success": true
}