Get Document By Id
Beta. The Documents API is in beta and its contract may change.
Returns a Document object with the given id, including the parsed data object when data_status is AVAILABLE. This is the only endpoint that returns data; it is otherwise identical to the list response.
Authorizations
Query Parameters
Response
Successful Response
The Document object represents a file held in an HR or payroll system for an employee, together with the field values Bindbee parsed out of it where the document type follows a standard form.
The normalised document type, set from the provider's own category or, where that is missing, from content anchors in the file itself. If the value is not one of the defined enum values, the original value passed through will be returned.
W4, I9, OTHER, - "W4"
Whether parsed field values are available for this document. AVAILABLE: use data. PENDING: extraction is still running, wait for the document.data.available webhook. UNSUPPORTED: Bindbee does not parse this document type, download the file instead. FAILED: extraction was attempted and did not succeed, download the file instead. Returned on both the list and the detail endpoint, so you can tell which documents are worth fetching in full without fetching any of them.
AVAILABLE, PENDING, UNSUPPORTED, FAILED "AVAILABLE"
The parsed values of a Form W-4. Fields that belong to the other era's form are returned as null rather than zero: a zero is a claim the employee made, a null is a box that did not exist on the form they signed. Source systems commonly return zero for both, so this normalisation is Bindbee's. A blank Step 3 or Step 4 box on a filled 2020 or later form is an affirmative zero, not a null.