plaid2.model.watchlist_screening_document module

class plaid2.model.watchlist_screening_document.WatchlistScreeningDocument(*, type: str, number: str)[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

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

number: str: The numeric or alphanumeric identifier associated with this document.

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

type: str

The kind of official document represented by this object.

birth_certificate - A certificate of birth

drivers_license - A license to operate a motor vehicle

immigration_number - Immigration or residence documents

military_id - Identification issued by a military group

other - Any document not covered by other categories

passport - An official passport issue by a government

personal_identification - Any generic personal identification that is not covered by other categories

ration_card - Identification that entitles the holder to rations

ssn - United States Social Security Number

student_id - Identification issued by an educational institution

tax_id - Identification issued for the purpose of collecting taxes

travel_document - Visas, entry permits, refugee documents, etc.

voter_id - Identification issued for the purpose of voting