plaid2.model.physical_document_images module

class plaid2.model.physical_document_images.PhysicalDocumentImages(*, original_back: Optional[str] = None, original_front: str, cropped_back: Optional[str] = None, face: Optional[str] = None, cropped_front: Optional[str] = None)

Bases: BaseModel

cropped_back: Optional[str]

Temporary URL that expires after 60 seconds for downloading a cropped image containing just the back of the document. Might be null if the back of the document was not collected.

cropped_front: Optional[str]

Temporary URL that expires after 60 seconds for downloading a cropped image containing just the front of the document.

dict(**kwargs: Any) → Dict[str, Any]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

face: Optional[str]

Temporary URL that expires after 60 seconds for downloading a crop of just the user’s face from the document image. Might be null if the document does not contain a face photo.

json(**kwargs: Any) → str

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

original_back: Optional[str]

Temporary URL that expires after 60 seconds for downloading the original image of the back of the document. Might be null if the back of the document was not collected.

original_front: str

Temporary URL that expires after 60 seconds for downloading the uncropped original image of the front of the document.

classmethod parse_obj(data: Any) → PhysicalDocumentImages

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PhysicalDocumentImages

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw