SIsignalshq
DOCUMENT

Get extraction response for a document grouped by year (V2)

V2 endpoint: Returns extracted attributes for the specified document, grouped and sorted by year. Attributes are grouped using the year column stored in the database. Each year group contains attributes with key, display_name, datatype, confidence_score, bounding_regions, status, and optionally document_key (for LLM extractions). Years are sorted in descending order. The document must belong to the authenticated user's tenant and the specified client.

post/internal/api/document/v2/{document_id}/response

Request

  • Base URL
    https://api.signalshq.io (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URL: /auth/login

Path parameters

document_idstring uuid required

Document ID

Request body

client_idstring uuid required

Client ID for the document

Response

Successful Response

document_classificationstring nullable

DEPRECATED legacy LLM classification varchar from tenant_client_dms_documents.document_classification. Frozen at upload — NOT updated on reclassify, so it goes stale once the user supersedes the type. Use document_type_identifier for routing.

document_type_identifierstring nullable

Canonical document_identifier of the document's CURRENT type (e.g. 'SCH_K1_1065'), resolved from the canonical document_type_id. Source of truth after a reclassify — route the review screen on THIS, not on the (possibly stale) document_classification.

provided_document_type_idstring uuid nullable

Document type UUID from POST /internal/api/document/extract request body when document_type_id was supplied (reextract-with-type). Null when extraction was triggered by upload or by extract without that field; resolved type is still stored on the extraction job as document_type_id.

extraction_statusstring nullable

Status of the document's latest extraction job (e.g. COMPLETED, FAILED, SKIPPED, UNSUPPORTED). Lets the UI distinguish a genuinely-empty document from one where automatic extraction FAILED or returned nothing — so it can show an 'extraction unavailable, enter values manually' banner instead of treating blank fields as verified-empty. The fields in data are always the document type's editable schema.

Example response

{
  "document_type_identifier": "FORM_W2"
}

Changes

No recorded changes to this operation across all 1 revision of this API.