Upload a document to ERE

Required scope: ere-uploads:write.

Step 3 of an ERE upload: submit a ready upload session to SSA's Electronic Records Express for the session's client. This files a document with SSA, and a submission cannot be recalled once it has started.

Send the upload_session_id and the ERE document type. Medical record types that cover a treatment period require treatment_source, treatment_start_date and treatment_end_date; all other types require document_date. notes and upload_external_id (your own reference) are optional.

Chronicle checks the client's SSN, ERE access and case status before submitting, and again just before sending to SSA. A client that cannot receive ERE uploads returns 409 ere_ineligible; a session that is not ready or has expired returns 409 upload_not_ready or 409 upload_session_expired. Each upload session can be submitted only once, even after its idempotency key expires.

The upload is queued, not complete. Poll Get an ERE upload or subscribe to the v2.ere_upload.* webhooks.

Requires an Idempotency-Key. Retrying with the same key and body within 24 hours returns the original result without repeating the action. Counts toward the heavy-operation rate limit.

POST /api/v2/ere-uploads
Bearer token scope ere-uploads:write

Headers

· 1
Idempotency-Key string · min length: 1· max length: 128 · pattern required

Unique key for this operation, 1 to 128 visible ASCII characters (for example a UUID). Reuse it only when retrying the same request.

Body

· EreUploadCreate
required application/json
upload_session_id string · uuid · pattern required
type string · max length: 200 required
notes string | null · default: null
document_date string | null · default: null
treatment_source string | null · default: null
treatment_start_date string | null · default: null
treatment_end_date string | null · default: null
upload_external_id string | null · default: null

Responses