Document
Returned document metadata, including the DIP-assigned classification result. language, issuers, title and documentDate are omitted until DIP completes, and are returned only when DIP can derive them.
- categoryType: enumnullableread-onlyrequired
Category assigned by DIP classification. Null when no classification result is available, including before classification. The value other represents a classified result, not a pending state.
valueslab_resultimaging_reportconsultation_notedischarge_summaryprescriptionvaccinationgenetic_reportquestionnaireother - contentType: string
Type - documentType: stringFormat: date
Date read-onlyDate of the test or consultation inferred by DIP, not the upload date. Returned only after DIP completes and the value is available.
- externalType: string
Id max length:128 - extractType: boolean
Data Extract structured health data. Set false to store without data extraction; PII scrubbing must remain enabled. Omission means true. Cannot be false together with scrubPII.
- Properties: 4extractionType: object | null
- fileType: string
Name - idType: string
- issuersType:read-onlyProperties: 5
Issuers identified from document evidence. Returned only after DIP completes; an empty array means no issuer was identified. Organisation and practitioner links are optional, verified and filtered by caller permissions. This is not an organisation staff directory.
- languageType: stringread-only
Document language detected by DIP. Returned only after DIP completes and the value is available.
- pageType: integer | null
Count Integer numbers.
- processedType: string | nullFormat: date-time
At the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- scrubType: boolean
P I I Scrub personally identifiable information from the document. Omission means true. Cannot be false together with extractData.
- sha256Type: string
- sizeType: integer
Bytes Integer numbers.
- statusType: enum
uploading (presigned slot open) -> received -> scanning (malware and format check) -> processing (OCR and extraction) -> processed | partially_processed.
rejected= failed scan or unsupported content;failed= extraction error (file kept, retryable).valuesuploadingreceivedscanningprocessingprocessedpartially_processedfailedrejected - statusType: string | null
Reason - titleType: stringmax length:200read-only
DIP-derived document title. Returned only after DIP completes and the value is available.
- uploadedType: stringFormat: date-time
At the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- userType:
Id
{
"id": "doc_01JA2Z...",
"userId": "usr_01JA2Y7Q3K8V5T0N4R6M2P9XWE",
"category": null,
"externalId": "synthetic-report-001",
"extractData": true,
"scrubPII": true,
"status": "received",
"fileName": "synthetic-lab-report.pdf",
"contentType": "application/pdf",
"sizeBytes": 1024,
"uploadedAt": "2026-10-12T08:00:00Z",
"processedAt": null
}