plaid2.model.document_metadata module
- class plaid2.model.document_metadata.DocumentMetadata(*, status: Optional[str] = None, doc_type: Optional[str] = None, name: Optional[str] = None, doc_id: Optional[str] = None)[source]
Bases:
BaseModel- dict(**kwargs: Any) Dict[str, Any][source]
Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict
- doc_id: Optional[str]
An identifier of the document that is also present in the paystub response.
- doc_type: Optional[str]
The type of document.
DOCUMENT_TYPE_PAYSTUB: A paystub.
DOCUMENT_TYPE_BANK_STATEMENT: A bank statement.
DOCUMENT_TYPE_US_TAX_W2: A W-2 wage and tax statement provided by a US employer reflecting wages earned by the employee.
DOCUMENT_TYPE_US_MILITARY_ERAS: An electronic Retirement Account Statement (eRAS) issued by the US military.
DOCUMENT_TYPE_US_MILITARY_LES: A Leave and Earnings Statement (LES) issued by the US military.
DOCUMENT_TYPE_US_MILITARY_CLES: A Civilian Leave and Earnings Statment (CLES) issued by the US military.
DOCUMENT_TYPE_GIG: Used to indicate that the income is related to gig work. Does not necessarily correspond to a specific document type.
DOCUMENT_TYPE_NONE: Used to indicate that there is no underlying document for the data.
UNKNOWN: Document type could not be determined.
- json(**kwargs: Any) str[source]
Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json
- name_: Optional[str]
The name of the document.
- classmethod parse_obj(data: Any) DocumentMetadata[source]
Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj
- classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) DocumentMetadata[source]
Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw
- status: Optional[str]
The processing status of the document.