Get a document extraction

Required scope: documents:read.

Returns one extraction type for a document. An unknown type returns 422. A known type that has no extraction for this document, or a document that is missing or inaccessible, returns 404.

When result_status is available, result.fields holds the extracted values in the published schema for that type and source_schema_version. Otherwise result is null; raw, unvalidated output is never returned. Fields that were not found are omitted, and dates are returned as written in the document rather than normalized.

completed_at refers to the latest processing attempt, while result.extracted_at refers to the result returned. schema_stale describes schema compatibility only; it is not a confidence score and does not indicate whether the document has changed. Claimant SSN, date of birth, SSN last four and BNC are never included.

GET /api/v2/documents/{id}/extractions/{type}
Bearer token scope documents:read

Path parameters

· 2
id string required

Document ID.

type string · enum required

Extraction type.

values

  • determination_transmittal
  • decision_alj
  • decision_ac
  • denial_notice
  • determination
  • notice_of_award

Responses