plaid2.model.identity_verification_create_request module

class plaid2.model.identity_verification_create_request.IdentityVerificationCreateRequest(*, gave_consent: bool, user: IdentityVerificationRequestUser, is_idempotent: Optional[bool] = None, is_shareable: bool, template_id: str)

Bases: BaseModel

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

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

gave_consent: bool

A flag specifying whether the end user has already agreed to a privacy policy specifying that their data will be shared with Plaid for verification purposes.

If gave_consent is set to true, the accept_tos step will be marked as skipped and the end user’s session will start at the next step requirement.

is_idempotent: Optional[bool]

An optional flag specifying how you would like Plaid to handle attempts to create an Identity Verification when an Identity Verification already exists for the provided client_user_id and template_id. If idempotency is enabled, Plaid will return the existing Identity Verification. If idempotency is disabled, Plaid will reject the request with a 400 Bad Request status code if an Identity Verification already exists for the supplied client_user_id and template_id.

is_shareable: bool

A flag specifying whether you would like Plaid to expose a shareable URL for the verification being created.

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

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

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

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

template_id: str

ID of the associated Identity Verification template.

user: IdentityVerificationRequestUser

User information collected outside of Link, most likely via your own onboarding process.

Each of the following identity fields are optional:

email_address

phone_number

date_of_birth

name

address

id_number Specifically, these fields are optional in that they can either be fully provided (satisfying every required field in their subschema) or omitted from the request entirely by not providing the key or value. Providing these fields via the API will result in Link skipping the data collection process for the associated user. All verification steps enabled in the associated Identity Verification Template will still be run. Verification steps will either be run immediately, or once the user completes the accept_tos step, depending on the value provided to the gave_consent field.