Interface StartVerificationResponse.Builder

  • Method Details

    • verificationType

      StartVerificationResponse.Builder verificationType(String verificationType)

      The type of verification that was started based on the provided verification details.

      Parameters:
      verificationType - The type of verification that was started based on the provided verification details.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • verificationType

      StartVerificationResponse.Builder verificationType(VerificationType verificationType)

      The type of verification that was started based on the provided verification details.

      Parameters:
      verificationType - The type of verification that was started based on the provided verification details.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • verificationStatus

      StartVerificationResponse.Builder verificationStatus(String verificationStatus)

      The initial status of the verification process after it has been started. Typically this will be pending or in-progress.

      Parameters:
      verificationStatus - The initial status of the verification process after it has been started. Typically this will be pending or in-progress.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • verificationStatus

      StartVerificationResponse.Builder verificationStatus(VerificationStatus verificationStatus)

      The initial status of the verification process after it has been started. Typically this will be pending or in-progress.

      Parameters:
      verificationStatus - The initial status of the verification process after it has been started. Typically this will be pending or in-progress.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • verificationStatusReason

      StartVerificationResponse.Builder verificationStatusReason(String verificationStatusReason)

      Additional information about the initial verification status, including any immediate feedback about the submitted verification details.

      Parameters:
      verificationStatusReason - Additional information about the initial verification status, including any immediate feedback about the submitted verification details.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • verificationResponseDetails

      StartVerificationResponse.Builder verificationResponseDetails(VerificationResponseDetails verificationResponseDetails)

      Initial response details specific to the type of verification started, which may include next steps or additional requirements.

      Parameters:
      verificationResponseDetails - Initial response details specific to the type of verification started, which may include next steps or additional requirements.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • verificationResponseDetails

      default StartVerificationResponse.Builder verificationResponseDetails(Consumer<VerificationResponseDetails.Builder> verificationResponseDetails)

      Initial response details specific to the type of verification started, which may include next steps or additional requirements.

      This is a convenience method that creates an instance of the VerificationResponseDetails.Builder avoiding the need to create one manually via VerificationResponseDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to verificationResponseDetails(VerificationResponseDetails).

      Parameters:
      verificationResponseDetails - a consumer that will call methods on VerificationResponseDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • startedAt

      The timestamp when the verification process was successfully initiated.

      Parameters:
      startedAt - The timestamp when the verification process was successfully initiated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • completedAt

      StartVerificationResponse.Builder completedAt(Instant completedAt)

      The timestamp when the verification process was completed. This field is typically null for newly started verifications unless they complete immediately.

      Parameters:
      completedAt - The timestamp when the verification process was completed. This field is typically null for newly started verifications unless they complete immediately.
      Returns:
      Returns a reference to this object so that method calls can be chained together.