Interface IdentityDocument.Builder

All Superinterfaces:
Buildable, CopyableBuilder<IdentityDocument.Builder,IdentityDocument>, SdkBuilder<IdentityDocument.Builder,IdentityDocument>, SdkPojo
Enclosing class:
IdentityDocument
public static interface IdentityDocument.Builder extends SdkPojo, CopyableBuilder<IdentityDocument.Builder,IdentityDocument>

  • Method Details

    • documentIndex

      IdentityDocument.Builder documentIndex(Integer documentIndex)

      Denotes the placement of a document in the IdentityDocument list. The first document is marked 1, the second 2 and so on.

      Parameters:
      documentIndex - Denotes the placement of a document in the IdentityDocument list. The first document is marked 1, the second 2 and so on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • identityDocumentFields

      IdentityDocument.Builder identityDocumentFields(Collection<IdentityDocumentField> identityDocumentFields)

      The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.

      Parameters:
      identityDocumentFields - The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • identityDocumentFields

      IdentityDocument.Builder identityDocumentFields(IdentityDocumentField... identityDocumentFields)

      The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.

      Parameters:
      identityDocumentFields - The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • identityDocumentFields

      IdentityDocument.Builder identityDocumentFields(Consumer<IdentityDocumentField.Builder>... identityDocumentFields)

      The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to identityDocumentFields(List<IdentityDocumentField>).

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

    • blocks

      IdentityDocument.Builder blocks(Collection<Block> blocks)

      Individual word recognition, as returned by document detection.

      Parameters:
      blocks - Individual word recognition, as returned by document detection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • blocks

      IdentityDocument.Builder blocks(Block... blocks)

      Individual word recognition, as returned by document detection.

      Parameters:
      blocks - Individual word recognition, as returned by document detection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • blocks

      IdentityDocument.Builder blocks(Consumer<Block.Builder>... blocks)

      Individual word recognition, as returned by document detection.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to blocks(List<Block>).

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