plaid2.model.physical_document_extracted_data module

class plaid2.model.physical_document_extracted_data.PhysicalDocumentExtractedData(*, expiration_date: Optional[str] = None, category: str, id_number: Optional[str] = None, issuing_country: str)

Bases: BaseModel

category: str

The type of identity document detected in the images provided. Will always be one of the following values:

drivers_license - A driver’s license for the associated country

id_card - A general national identification card, distinct from driver’s licenses

passport - A passport for the associated country

residence_permit_card - An identity document permitting a foreign citizen to <em>temporarily</em> reside in the associated country

resident_card - An identity document permitting a foreign citizen to <em>permanently</em> reside in the associated country

Note: This value may be different from the ID type that the user selects within Link. For example, if they select “Driver’s License” but then submit a picture of a passport, this field will say passport

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

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

expiration_date: Optional[str]

id_number: Optional[str]

Alpha-numeric ID number extracted via OCR from the user’s document image.

issuing_country: str

Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.

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) → PhysicalDocumentExtractedData

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

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

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