Read a verification request

Read one request, including its token and link, so the requester page can re-show and re-print them.

get/v1/requests/{request_id}

Request

  • Base URL: https://api.lumethic.com
  • URL: https://api.lumethic.com/v1/requests/{request_id}
  • Auth: OAuth2PasswordBearer (a scheme the document does not define)

Path parameters

request_idstring uuid required

Headers

X-API-Keystring nullable

Response

Successful Response

idstring uuid required
subjectstring required
instructionsstring nullable required
mode'existing_original' | 'capture' required

How the provider answers a request: an uploaded camera original, or a capture with Lumethic Capture.

status'open' | 'closed' | 'expired' required

Derived status of a verification request.

open and closed are stored; expired is open past expires_at and is never written to the row.

expires_atstring date-time required
closed_atstring date-time nullable required
max_submissionsinteger required
submission_countinteger required

Accepted uploads so far (counted, never stored).

share_with_providerboolean required
tokenstring required

Bearer secret: anyone holding it can open the landing page and upload to this request until it closes, expires or fills. Returned on every owner read; listing requests exposes every open link of the account.

urlstring required

The landing page link (and the QR code's content): {FRONTEND_URL}/r/{token}.

created_atstring date-time required
updated_atstring date-time required

Changes

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