plaid2.model.documentary_verification_document module

class plaid2.model.documentary_verification_document.DocumentaryVerificationDocument(*, analysis: DocumentAnalysis, attempt: float, status: str, images: PhysicalDocumentImages, extracted_data: Optional[PhysicalDocumentExtractedData] = None)[source]

Bases: BaseModel

analysis: DocumentAnalysis: High level descriptions of how the associated document was processed. If a document fails verification, the details in the analysis object should help clarify why the document was rejected.

attempt: float: The attempt field begins with 1 and increments with each subsequent document upload.

dict(**kwargs: Any) → Dict[str, Any][source]: Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

extracted_data: Optional[PhysicalDocumentExtractedData]: Data extracted from a user-submitted document.

images: PhysicalDocumentImages: URLs for downloading original and cropped images for this document submission. The URLs are designed to only allow downloading, not hot linking, so the URL will only serve the document image for 60 seconds before expiring. The expiration time is 60 seconds after the GET request for the associated Identity Verification attempt. A new expiring URL is generated with each request, so you can always rerequest the Identity Verification attempt if one of your URLs expires.

json(**kwargs: Any) → str[source]: Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → DocumentaryVerificationDocument[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) → DocumentaryVerificationDocument[source]: Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

status: str: An outcome status for this specific document submission. Distinct from the overall documentary_verification.status that summarizes the verification outcome from one or more documents.