Skip to main content
POST
Upload Document

Overview

Upload a medical referral document along with associated metadata for processing. This endpoint accepts multipart form data with the document file and related information.

Endpoint

Base URL: https://app.arahealth.io Path: /api/v1/pub/records/document-upload Method: POST

Request Parameters

Headers

  • Authorization (required) - Bearer token for authentication (format: Bearer ara_live_YOUR_API_KEY)

Form Data

  • referral (required) - The referral document file (PDF, image, etc.)
  • referralSource (optional) - Source of the referral

Code Examples

Response

A successful upload returns a JSON object with the following structure:

Response Fields

  • data - Array of uploaded document records
    • name - Filename of the uploaded document
    • status - Processing status (complete, incomplete)
    • record_id - Unique identifier for the uploaded record
  • status_code - HTTP status code (200 for success)
  • message - Status message

Authorizations

Authorization
string
header
required

Bearer token authentication using your Alto Health API key

Body

multipart/form-data

Multipart form data containing document and metadata

referral
file
required

The referral document file (PDF, image, etc.)

referralSource
string

Optional source of the referral

Example:

""

Response

Document uploaded successfully

data
object[]

Array of uploaded document records

status_code
integer

HTTP status code

Example:

200

message
string

Status message

Example:

"success"