Skip to main content
POST
/
api
/
v1
/
pub
/
records
/
document-upload
Upload Document
curl --request POST \
  --url https://app.arahealth.io/api/v1/pub/records/document-upload \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form referral='@example-file' \
  --form referralSource=
{
  "data": [
    {
      "name": "SyntheticReferral-Breast-T1-01-10-04-2025-NA-009.pdf",
      "status": "complete",
      "record_id": "example_record_id_123"
    }
  ],
  "status_code": 200,
  "message": "success"
}

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

POST https://app.arahealth.io/api/v1/pub/records/document-upload
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

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://app.arahealth.io/api/v1/pub/records/document-upload");
request.Headers.Add("Authorization", "Bearer ara_live_YOUR_API_KEY");

var content = new MultipartFormDataContent();
content.Add(new StreamContent(File.OpenRead("/path/to/referral.pdf")), "referral", "referral.pdf");
content.Add(new StringContent(""), "referralSource");

request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Response

A successful upload returns a JSON object with the following structure:
{
  "data": [
    {
      "name": "XXXXSyntheticReferral-Breast-T1-03-10-04-2025-NA-008.docx.pdf",
      "status": "complete",
      "record_id": "692b56267a5069e2517787e5"
    }
  ],
  "status_code": 200,
  "message": "success"
}

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"