IdentityVerificationCreateRequest (com.plaid:plaid-java 18.0.0 API)

java.lang.Object
- com.plaid.client.model.IdentityVerificationCreateRequest

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-17T22:44:09.100608Z[Etc/UTC]")
public class IdentityVerificationCreateRequest
extends Object

Request schema for '/identity_verification/create'

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_CLIENT_ID`
`static String`	`SERIALIZED_NAME_CLIENT_USER_ID`
`static String`	`SERIALIZED_NAME_GAVE_CONSENT`
`static String`	`SERIALIZED_NAME_IS_IDEMPOTENT`
`static String`	`SERIALIZED_NAME_IS_SHAREABLE`
`static String`	`SERIALIZED_NAME_SECRET`
`static String`	`SERIALIZED_NAME_TEMPLATE_ID`
`static String`	`SERIALIZED_NAME_USER`

Constructor Summary

Constructors
Constructor and Description

IdentityVerificationCreateRequest()

Constructors
Constructor and Description
`IdentityVerificationCreateRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IdentityVerificationCreateRequest`	`clientId(String clientId)`
`IdentityVerificationCreateRequest`	`clientUserId(String clientUserId)`
`boolean`	`equals(Object o)`
`IdentityVerificationCreateRequest`	`gaveConsent(Boolean gaveConsent)`
`String`	`getClientId()` Your Plaid API `client_id`.
`String`	`getClientUserId()` A unique ID that identifies the end user in your system.
`Boolean`	`getGaveConsent()` 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.
`Boolean`	`getIsIdempotent()` 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`.
`Boolean`	`getIsShareable()` A flag specifying whether you would like Plaid to expose a shareable URL for the verification being created.
`String`	`getSecret()` Your Plaid API `secret`.
`String`	`getTemplateId()` ID of the associated Identity Verification template.
`IdentityVerificationCreateRequestUser`	`getUser()` Get user
`int`	`hashCode()`
`IdentityVerificationCreateRequest`	`isIdempotent(Boolean isIdempotent)`
`IdentityVerificationCreateRequest`	`isShareable(Boolean isShareable)`
`IdentityVerificationCreateRequest`	`secret(String secret)`
`void`	`setClientId(String clientId)`
`void`	`setClientUserId(String clientUserId)`
`void`	`setGaveConsent(Boolean gaveConsent)`
`void`	`setIsIdempotent(Boolean isIdempotent)`
`void`	`setIsShareable(Boolean isShareable)`
`void`	`setSecret(String secret)`
`void`	`setTemplateId(String templateId)`
`void`	`setUser(IdentityVerificationCreateRequestUser user)`
`IdentityVerificationCreateRequest`	`templateId(String templateId)`
`String`	`toString()`
`IdentityVerificationCreateRequest`	`user(IdentityVerificationCreateRequestUser user)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_CLIENT_USER_ID
```
public static final String SERIALIZED_NAME_CLIENT_USER_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_IS_SHAREABLE
```
public static final String SERIALIZED_NAME_IS_SHAREABLE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TEMPLATE_ID
```
public static final String SERIALIZED_NAME_TEMPLATE_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_GAVE_CONSENT
```
public static final String SERIALIZED_NAME_GAVE_CONSENT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_USER
```
public static final String SERIALIZED_NAME_USER
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CLIENT_ID
```
public static final String SERIALIZED_NAME_CLIENT_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SECRET
```
public static final String SERIALIZED_NAME_SECRET
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_IS_IDEMPOTENT
```
public static final String SERIALIZED_NAME_IS_IDEMPOTENT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IdentityVerificationCreateRequest
```
public IdentityVerificationCreateRequest()
```
- Method Detail
  - clientUserId
```
public IdentityVerificationCreateRequest clientUserId(String clientUserId)
```
  - getClientUserId
```
@Nullable
public String getClientUserId()
```
    A unique ID that identifies the end user in your system. This ID can also be used to associate user-specific data from other Plaid products. Financial Account Matching requires this field and the `/link/token/create` `client_user_id` to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the `client_user_id`.
    
    Returns:
    
    clientUserId
  - setClientUserId
```
public void setClientUserId(String clientUserId)
```
  - isShareable
```
public IdentityVerificationCreateRequest isShareable(Boolean isShareable)
```
  - getIsShareable
```
public Boolean getIsShareable()
```
    A flag specifying whether you would like Plaid to expose a shareable URL for the verification being created.
    
    Returns:
    
    isShareable
  - setIsShareable
```
public void setIsShareable(Boolean isShareable)
```
  - templateId
```
public IdentityVerificationCreateRequest templateId(String templateId)
```
  - getTemplateId
```
public String getTemplateId()
```
    ID of the associated Identity Verification template.
    
    Returns:
    
    templateId
  - setTemplateId
```
public void setTemplateId(String templateId)
```
  - gaveConsent
```
public IdentityVerificationCreateRequest gaveConsent(Boolean gaveConsent)
```
  - getGaveConsent
```
public Boolean getGaveConsent()
```
    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.
    
    Returns:
    
    gaveConsent
  - setGaveConsent
```
public void setGaveConsent(Boolean gaveConsent)
```
  - user
```
public IdentityVerificationCreateRequest user(IdentityVerificationCreateRequestUser user)
```
  - getUser
```
@Nullable
public IdentityVerificationCreateRequestUser getUser()
```
    Get user
    
    Returns:
    
    user
  - setUser
```
public void setUser(IdentityVerificationCreateRequestUser user)
```
  - clientId
```
public IdentityVerificationCreateRequest clientId(String clientId)
```
  - getClientId
```
@Nullable
public String getClientId()
```
    Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
    
    Returns:
    
    clientId
  - setClientId
```
public void setClientId(String clientId)
```
  - secret
```
public IdentityVerificationCreateRequest secret(String secret)
```
  - getSecret
```
@Nullable
public String getSecret()
```
    Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
    
    Returns:
    
    secret
  - setSecret
```
public void setSecret(String secret)
```
  - isIdempotent
```
public IdentityVerificationCreateRequest isIdempotent(Boolean isIdempotent)
```
  - getIsIdempotent
```
@Nullable
public Boolean getIsIdempotent()
```
    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`.
    
    Returns:
    
    isIdempotent
  - setIsIdempotent
```
public void setIsIdempotent(Boolean isIdempotent)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class IdentityVerificationCreateRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_CLIENT_USER_ID

SERIALIZED_NAME_IS_SHAREABLE

SERIALIZED_NAME_TEMPLATE_ID

SERIALIZED_NAME_GAVE_CONSENT

SERIALIZED_NAME_USER

SERIALIZED_NAME_CLIENT_ID

SERIALIZED_NAME_SECRET

SERIALIZED_NAME_IS_IDEMPOTENT

Constructor Detail

IdentityVerificationCreateRequest

Method Detail

clientUserId

getClientUserId

setClientUserId

isShareable

getIsShareable

setIsShareable

templateId

getTemplateId

setTemplateId

gaveConsent

getGaveConsent

setGaveConsent

user

getUser

setUser

clientId

getClientId

setClientId

secret

getSecret

setSecret

isIdempotent

getIsIdempotent

setIsIdempotent

equals

hashCode

toString