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

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

```
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-17T22:44:09.100608Z[Etc/UTC]")
public class IdentityVerificationCreateResponse
extends Object
```
A identity verification attempt represents a customer's attempt to verify their identity, reflecting the required steps for completing the session, the results for each step, and information collected in the process.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_CLIENT_USER_ID`
`static String`	`SERIALIZED_NAME_COMPLETED_AT`
`static String`	`SERIALIZED_NAME_CREATED_AT`
`static String`	`SERIALIZED_NAME_DOCUMENTARY_VERIFICATION`
`static String`	`SERIALIZED_NAME_ID`
`static String`	`SERIALIZED_NAME_KYC_CHECK`
`static String`	`SERIALIZED_NAME_PREVIOUS_ATTEMPT_ID`
`static String`	`SERIALIZED_NAME_REDACTED_AT`
`static String`	`SERIALIZED_NAME_REQUEST_ID`
`static String`	`SERIALIZED_NAME_RISK_CHECK`
`static String`	`SERIALIZED_NAME_SELFIE_CHECK`
`static String`	`SERIALIZED_NAME_SHAREABLE_URL`
`static String`	`SERIALIZED_NAME_STATUS`
`static String`	`SERIALIZED_NAME_STEPS`
`static String`	`SERIALIZED_NAME_TEMPLATE`
`static String`	`SERIALIZED_NAME_USER`
`static String`	`SERIALIZED_NAME_WATCHLIST_SCREENING_ID`

Constructor Summary

Constructors
Constructor and Description

IdentityVerificationCreateResponse()

Constructors
Constructor and Description
`IdentityVerificationCreateResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IdentityVerificationCreateResponse`	`clientUserId(String clientUserId)`
`IdentityVerificationCreateResponse`	`completedAt(OffsetDateTime completedAt)`
`IdentityVerificationCreateResponse`	`createdAt(Timestamp createdAt)`
`IdentityVerificationCreateResponse`	`documentaryVerification(DocumentaryVerification documentaryVerification)`
`boolean`	`equals(Object o)`
`String`	`getClientUserId()` A unique ID that identifies the end user in your system.
`OffsetDateTime`	`getCompletedAt()` An ISO8601 formatted timestamp.
`Timestamp`	`getCreatedAt()` Get createdAt
`DocumentaryVerification`	`getDocumentaryVerification()` Get documentaryVerification
`String`	`getId()` ID of the associated Identity Verification attempt.
`KYCCheckDetails`	`getKycCheck()` Get kycCheck
`String`	`getPreviousAttemptId()` The ID for the Identity Verification preceding this session.
`OffsetDateTime`	`getRedactedAt()` An ISO8601 formatted timestamp.
`String`	`getRequestId()` A unique identifier for the request, which can be used for troubleshooting.
`RiskCheckDetails`	`getRiskCheck()` Get riskCheck
`SelfieCheck`	`getSelfieCheck()` Get selfieCheck
`String`	`getShareableUrl()` A shareable URL that can be sent directly to the user to complete verification
`IdentityVerificationStatus`	`getStatus()` Get status
`IdentityVerificationStepSummary`	`getSteps()` Get steps
`IdentityVerificationTemplateReference`	`getTemplate()` Get template
`IdentityVerificationUserData`	`getUser()` Get user
`String`	`getWatchlistScreeningId()` ID of the associated screening.
`int`	`hashCode()`
`IdentityVerificationCreateResponse`	`id(String id)`
`IdentityVerificationCreateResponse`	`kycCheck(KYCCheckDetails kycCheck)`
`IdentityVerificationCreateResponse`	`previousAttemptId(String previousAttemptId)`
`IdentityVerificationCreateResponse`	`redactedAt(OffsetDateTime redactedAt)`
`IdentityVerificationCreateResponse`	`requestId(String requestId)`
`IdentityVerificationCreateResponse`	`riskCheck(RiskCheckDetails riskCheck)`
`IdentityVerificationCreateResponse`	`selfieCheck(SelfieCheck selfieCheck)`
`void`	`setClientUserId(String clientUserId)`
`void`	`setCompletedAt(OffsetDateTime completedAt)`
`void`	`setCreatedAt(Timestamp createdAt)`
`void`	`setDocumentaryVerification(DocumentaryVerification documentaryVerification)`
`void`	`setId(String id)`
`void`	`setKycCheck(KYCCheckDetails kycCheck)`
`void`	`setPreviousAttemptId(String previousAttemptId)`
`void`	`setRedactedAt(OffsetDateTime redactedAt)`
`void`	`setRequestId(String requestId)`
`void`	`setRiskCheck(RiskCheckDetails riskCheck)`
`void`	`setSelfieCheck(SelfieCheck selfieCheck)`
`void`	`setShareableUrl(String shareableUrl)`
`void`	`setStatus(IdentityVerificationStatus status)`
`void`	`setSteps(IdentityVerificationStepSummary steps)`
`void`	`setTemplate(IdentityVerificationTemplateReference template)`
`void`	`setUser(IdentityVerificationUserData user)`
`void`	`setWatchlistScreeningId(String watchlistScreeningId)`
`IdentityVerificationCreateResponse`	`shareableUrl(String shareableUrl)`
`IdentityVerificationCreateResponse`	`status(IdentityVerificationStatus status)`
`IdentityVerificationCreateResponse`	`steps(IdentityVerificationStepSummary steps)`
`IdentityVerificationCreateResponse`	`template(IdentityVerificationTemplateReference template)`
`String`	`toString()`
`IdentityVerificationCreateResponse`	`user(IdentityVerificationUserData user)`
`IdentityVerificationCreateResponse`	`watchlistScreeningId(String watchlistScreeningId)`

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

Field Detail

SERIALIZED_NAME_ID

public static final String SERIALIZED_NAME_ID

See Also:: Constant Field Values

SERIALIZED_NAME_CLIENT_USER_ID

public static final String SERIALIZED_NAME_CLIENT_USER_ID

See Also:: Constant Field Values

SERIALIZED_NAME_CREATED_AT

public static final String SERIALIZED_NAME_CREATED_AT

See Also:: Constant Field Values

SERIALIZED_NAME_COMPLETED_AT

public static final String SERIALIZED_NAME_COMPLETED_AT

See Also:: Constant Field Values

SERIALIZED_NAME_PREVIOUS_ATTEMPT_ID

public static final String SERIALIZED_NAME_PREVIOUS_ATTEMPT_ID

See Also:: Constant Field Values

SERIALIZED_NAME_SHAREABLE_URL

public static final String SERIALIZED_NAME_SHAREABLE_URL

See Also:: Constant Field Values

SERIALIZED_NAME_TEMPLATE

public static final String SERIALIZED_NAME_TEMPLATE

See Also:: Constant Field Values

SERIALIZED_NAME_USER

public static final String SERIALIZED_NAME_USER

See Also:: Constant Field Values

SERIALIZED_NAME_STATUS

public static final String SERIALIZED_NAME_STATUS

See Also:: Constant Field Values

SERIALIZED_NAME_STEPS

public static final String SERIALIZED_NAME_STEPS

See Also:: Constant Field Values

SERIALIZED_NAME_DOCUMENTARY_VERIFICATION

public static final String SERIALIZED_NAME_DOCUMENTARY_VERIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_SELFIE_CHECK

public static final String SERIALIZED_NAME_SELFIE_CHECK

See Also:: Constant Field Values

SERIALIZED_NAME_KYC_CHECK

public static final String SERIALIZED_NAME_KYC_CHECK

See Also:: Constant Field Values

SERIALIZED_NAME_RISK_CHECK

public static final String SERIALIZED_NAME_RISK_CHECK

See Also:: Constant Field Values

SERIALIZED_NAME_WATCHLIST_SCREENING_ID

public static final String SERIALIZED_NAME_WATCHLIST_SCREENING_ID

See Also:: Constant Field Values

SERIALIZED_NAME_REDACTED_AT

public static final String SERIALIZED_NAME_REDACTED_AT

See Also:: Constant Field Values

SERIALIZED_NAME_REQUEST_ID

public static final String SERIALIZED_NAME_REQUEST_ID

See Also:: Constant Field Values

Constructor Detail
- IdentityVerificationCreateResponse
```
public IdentityVerificationCreateResponse()
```

Method Detail

id

public IdentityVerificationCreateResponse id(String id)

getId
```
public String getId()
```
ID of the associated Identity Verification attempt.

Returns:

id

setId
```
public void setId(String id)
```

clientUserId

public IdentityVerificationCreateResponse clientUserId(String clientUserId)

getClientUserId
```
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)

createdAt

public IdentityVerificationCreateResponse createdAt(Timestamp createdAt)

getCreatedAt
```
public Timestamp getCreatedAt()
```
Get createdAt

Returns:

createdAt

setCreatedAt

public void setCreatedAt(Timestamp createdAt)

completedAt

public IdentityVerificationCreateResponse completedAt(OffsetDateTime completedAt)

getCompletedAt
```
@Nullable
public OffsetDateTime getCompletedAt()
```
An ISO8601 formatted timestamp.

Returns:

completedAt

setCompletedAt

public void setCompletedAt(OffsetDateTime completedAt)

previousAttemptId

public IdentityVerificationCreateResponse previousAttemptId(String previousAttemptId)

getPreviousAttemptId
```
@Nullable
public String getPreviousAttemptId()
```
The ID for the Identity Verification preceding this session. This field will only be filled if the current Identity Verification is a retry of a previous attempt.

Returns:

previousAttemptId

setPreviousAttemptId

public void setPreviousAttemptId(String previousAttemptId)

shareableUrl

public IdentityVerificationCreateResponse shareableUrl(String shareableUrl)

getShareableUrl
```
@Nullable
public String getShareableUrl()
```
A shareable URL that can be sent directly to the user to complete verification

Returns:

shareableUrl

setShareableUrl

public void setShareableUrl(String shareableUrl)

template

public IdentityVerificationCreateResponse template(IdentityVerificationTemplateReference template)

getTemplate

public IdentityVerificationTemplateReference getTemplate()

Get template

Returns:: template

setTemplate

public void setTemplate(IdentityVerificationTemplateReference template)

user

public IdentityVerificationCreateResponse user(IdentityVerificationUserData user)

getUser

public IdentityVerificationUserData getUser()

Get user

Returns:: user

setUser

public void setUser(IdentityVerificationUserData user)

status

public IdentityVerificationCreateResponse status(IdentityVerificationStatus status)

getStatus

public IdentityVerificationStatus getStatus()

Get status

Returns:: status

setStatus

public void setStatus(IdentityVerificationStatus status)

steps

public IdentityVerificationCreateResponse steps(IdentityVerificationStepSummary steps)

getSteps

public IdentityVerificationStepSummary getSteps()

Get steps

Returns:: steps

setSteps

public void setSteps(IdentityVerificationStepSummary steps)

documentaryVerification

public IdentityVerificationCreateResponse documentaryVerification(DocumentaryVerification documentaryVerification)

getDocumentaryVerification
```
@Nullable
public DocumentaryVerification getDocumentaryVerification()
```
Get documentaryVerification

Returns:

documentaryVerification

setDocumentaryVerification

public void setDocumentaryVerification(DocumentaryVerification documentaryVerification)

selfieCheck

public IdentityVerificationCreateResponse selfieCheck(SelfieCheck selfieCheck)

getSelfieCheck

@Nullable
public SelfieCheck getSelfieCheck()

Get selfieCheck

Returns:: selfieCheck

setSelfieCheck

public void setSelfieCheck(SelfieCheck selfieCheck)

kycCheck

public IdentityVerificationCreateResponse kycCheck(KYCCheckDetails kycCheck)

getKycCheck

@Nullable
public KYCCheckDetails getKycCheck()

Get kycCheck

Returns:: kycCheck

setKycCheck

public void setKycCheck(KYCCheckDetails kycCheck)

riskCheck

public IdentityVerificationCreateResponse riskCheck(RiskCheckDetails riskCheck)

getRiskCheck

@Nullable
public RiskCheckDetails getRiskCheck()

Get riskCheck

Returns:: riskCheck

setRiskCheck

public void setRiskCheck(RiskCheckDetails riskCheck)

watchlistScreeningId

public IdentityVerificationCreateResponse watchlistScreeningId(String watchlistScreeningId)

getWatchlistScreeningId
```
@Nullable
public String getWatchlistScreeningId()
```
ID of the associated screening.

Returns:

watchlistScreeningId

setWatchlistScreeningId

public void setWatchlistScreeningId(String watchlistScreeningId)

redactedAt

public IdentityVerificationCreateResponse redactedAt(OffsetDateTime redactedAt)

getRedactedAt
```
@Nullable
public OffsetDateTime getRedactedAt()
```
An ISO8601 formatted timestamp.

Returns:

redactedAt

setRedactedAt

public void setRedactedAt(OffsetDateTime redactedAt)

requestId

public IdentityVerificationCreateResponse requestId(String requestId)

getRequestId
```
public String getRequestId()
```
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Returns:

requestId

setRequestId

public void setRequestId(String requestId)

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 IdentityVerificationCreateResponse

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ID

SERIALIZED_NAME_CLIENT_USER_ID

SERIALIZED_NAME_CREATED_AT

SERIALIZED_NAME_COMPLETED_AT

SERIALIZED_NAME_PREVIOUS_ATTEMPT_ID

SERIALIZED_NAME_SHAREABLE_URL

SERIALIZED_NAME_TEMPLATE

SERIALIZED_NAME_USER

SERIALIZED_NAME_STATUS

SERIALIZED_NAME_STEPS

SERIALIZED_NAME_DOCUMENTARY_VERIFICATION

SERIALIZED_NAME_SELFIE_CHECK

SERIALIZED_NAME_KYC_CHECK

SERIALIZED_NAME_RISK_CHECK

SERIALIZED_NAME_WATCHLIST_SCREENING_ID

SERIALIZED_NAME_REDACTED_AT

SERIALIZED_NAME_REQUEST_ID

Constructor Detail

IdentityVerificationCreateResponse

Method Detail

id

getId

setId

clientUserId

getClientUserId

setClientUserId

createdAt

getCreatedAt

setCreatedAt

completedAt

getCompletedAt

setCompletedAt

previousAttemptId

getPreviousAttemptId

setPreviousAttemptId

shareableUrl

getShareableUrl

setShareableUrl

template

getTemplate

setTemplate

user

getUser

setUser

status

getStatus

setStatus

steps

getSteps

setSteps

documentaryVerification

getDocumentaryVerification

setDocumentaryVerification

selfieCheck

getSelfieCheck

setSelfieCheck

kycCheck

getKycCheck

setKycCheck

riskCheck

getRiskCheck

setRiskCheck

watchlistScreeningId

getWatchlistScreeningId

setWatchlistScreeningId

redactedAt

getRedactedAt

setRedactedAt

requestId

getRequestId

setRequestId

equals

hashCode

toString