Get invitation details

Use this endpoint to inspect a specific invitation. It reports the upload channel, message state, photo and quality-control state, timestamps, and invitation URL where applicable.

An upload performed by the kiosk or app can close the initial invitation and create a new invitation_key. The response then includes the upload record under uploaded_with. Do not rely on a permanent invitation_key ↔ customer_no mapping; use GET /search when customer_no is the stable identifier.

Request parameters

Parameter	Required	Description
invitation_key	Yes	Unique invitation key.
language_interface	No	Translate response messages to en, de, fr, or it.

Response

{
  "invitation_key": "o2hIyfWYpMq8",
  "customer_no": "123456789",
  "customer_to": "+41760000000",
  "photocode": null,
  "locale": "en_US",
  "upload_channel": "invitation",
  "site_name": "Demo",
  "site_code": "demo",
  "photo_status": null,
  "qc_status": null,
  "qc_failed_reason": null,
  "created_at": "2024-03-12T17:07:55+01:00",
  "expires_at": null,
  "uploaded_at": null,
  "exported_at": null,
  "received_at": null,
  "invitation_url": "https://demo.photocollect.io/c/o2hIyfWYpMq8",
  "iteration": 1,
  "message_status": "delivered"
}

Unknown keys return HTTP 400 with GET_INVITATION_FAILED.