Class Docupass.CreateRequest

java.lang.Object
com.idanalyzer.Docupass.CreateRequest
Enclosing class:
Docupass

public static class Docupass.CreateRequest extends Object
Parameters for creating a Docupass link.
  • Field Details

    • profile

      public String profile
      KYC profile ID (required).
    • mode

      public int mode
      Verification mode: 0=Document+Face, 1=Document, 2=Face, 3=e-Signature.
    • contractFormat

      public String contractFormat
      Output format for generated contracts; defaults to "pdf".
    • contractGenerate

      public String contractGenerate
      Contract template id to generate, if any.
    • contractSign

      public String contractSign
      Contract template id to have the user sign, if any.
    • contractPrefill

      public String contractPrefill
      Pre-fill data for the generated/signed contract, if any.
    • reusable

      public boolean reusable
      Whether the link can be reused by multiple users.
    • customData

      public String customData
      Arbitrary string stored with the resulting transaction.
    • language

      public String language
      UI language for the verification flow.
    • referenceDocument

      public String referenceDocument
      Reference document image to match against.
    • referenceDocumentBack

      public String referenceDocumentBack
      Reference document back image to match against.
    • referenceFace

      public String referenceFace
      Reference face image to match against.
    • userPhone

      public String userPhone
      User phone number for the verification flow.
    • verifyAddress

      public String verifyAddress
      Expected address to verify against the document.
    • verifyAge

      public String verifyAge
      Expected age range to verify against the document.
    • verifyDOB

      public String verifyDOB
      Expected date of birth to verify (docupass uses the upper-case "verifyDOB" field).
    • verifyDocumentNumber

      public String verifyDocumentNumber
      Expected document number to verify.
    • verifyName

      public String verifyName
      Expected name to verify against the document.
    • verifyPostcode

      public String verifyPostcode
      Expected postcode to verify against the document.
  • Constructor Details

    • CreateRequest

      public CreateRequest()
      Creates an empty request whose fields are populated directly before use.