plaid2.model.documentary_verification module

class plaid2.model.documentary_verification.DocumentaryVerification(*, status: str, documents: List[DocumentaryVerificationDocument])

Bases: BaseModel

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

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

documents: List[DocumentaryVerificationDocument]

An array of documents submitted to the documentary_verification step. Each entry represents one user submission, where each submission will contain both a front and back image, or just a front image, depending on the document type.

Note: Plaid will automatically let a user submit a new set of document images up to three times if we detect that a previous attempt might have failed due to user error. For example, if the first set of document images are blurry or obscured by glare, the user will be asked to capture their documents again, resulting in at least two separate entries within documents. If the overall documentary_verification is failed, the user has exhausted their retry attempts.

json(**kwargs: Any) → str

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

classmethod parse_obj(data: Any) → DocumentaryVerification

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

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

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

status: str

The outcome status for the associated Identity Verification attempt’s documentary_verification step. This field will always have the same value as steps.documentary_verification.