Package markets.alpaca.client.openapi.broker.model

Class CIPDocument

java.lang.Object
markets.alpaca.client.openapi.broker.model.CIPDocument
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class CIPDocument extends Object implements Serializable
Represents results of checking a document for CIPInfo
See Also:

  • Field Details

  • Constructor Details

    • CIPDocument

      public CIPDocument()

  • Method Details

    • ageValidation

      public CIPDocument ageValidation(@Nullable String ageValidation)

    • getAgeValidation

      @Nullable public String getAgeValidation()
      The result of the check. Either `clear` or `consider`.
      Returns:
      ageValidation

    • setAgeValidation

      public void setAgeValidation(@Nullable String ageValidation)

    • comprisedDocument

      public CIPDocument comprisedDocument(@Nullable String comprisedDocument)

    • getComprisedDocument

      @Nullable public String getComprisedDocument()
      The result of the check. Either `clear` or `consider`.
      Returns:
      comprisedDocument

    • setComprisedDocument

      public void setComprisedDocument(@Nullable String comprisedDocument)

    • createdAt

      public CIPDocument createdAt(@Nullable OffsetDateTime createdAt)

    • getCreatedAt

      @Nullable public OffsetDateTime getCreatedAt()
      Datetime for when this check was done
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(@Nullable OffsetDateTime createdAt)

    • dataComparison

      public CIPDocument dataComparison(@Nullable String dataComparison)

    • getDataComparison

      @Nullable public String getDataComparison()
      The result of the check. Either `clear` or `consider`.
      Returns:
      dataComparison

    • setDataComparison

      public void setDataComparison(@Nullable String dataComparison)

    • dataComparisonBreakdown

      public CIPDocument dataComparisonBreakdown(@Nullable String dataComparisonBreakdown)

    • getDataComparisonBreakdown

      @Nullable public String getDataComparisonBreakdown()
      json object representing the results of the various sub-checks done when calculating the result on `data_comparison`. Example: {\"date_of_birth\": \"clear\", \"date_of_expiry\": \"clear\" \"document_numbers\": \"clear\", \"document_type\": \"clear\", \"first_name\": \"clear\", \"gender\": \"clear\", \"issuing_country\": \"clear\", \"last_name\": \"clear\"}
      Returns:
      dataComparisonBreakdown

    • setDataComparisonBreakdown

      public void setDataComparisonBreakdown(@Nullable String dataComparisonBreakdown)

    • dateOfBirth

      public CIPDocument dateOfBirth(@Nullable LocalDate dateOfBirth)

    • getDateOfBirth

      @Nullable public LocalDate getDateOfBirth()
      Datetime for when this check was done
      Returns:
      dateOfBirth

    • setDateOfBirth

      public void setDateOfBirth(@Nullable LocalDate dateOfBirth)

    • dateOfExpiry

      public CIPDocument dateOfExpiry(@Nullable LocalDate dateOfExpiry)

    • getDateOfExpiry

      @Nullable public LocalDate getDateOfExpiry()
      Datetime for when this check was done
      Returns:
      dateOfExpiry

    • setDateOfExpiry

      public void setDateOfExpiry(@Nullable LocalDate dateOfExpiry)

    • documentNumbers

      public CIPDocument documentNumbers(@Nullable List<String> documentNumbers)

    • addDocumentNumbersItem

      public CIPDocument addDocumentNumbersItem(String documentNumbersItem)

    • getDocumentNumbers

      @Nullable public List<String> getDocumentNumbers()
      Number of the document that was checked
      Returns:
      documentNumbers

    • setDocumentNumbers

      public void setDocumentNumbers(@Nullable List<String> documentNumbers)

    • documentType

      public CIPDocument documentType(@Nullable String documentType)

    • getDocumentType

      @Nullable public String getDocumentType()
      Type of the document that was checked
      Returns:
      documentType

    • setDocumentType

      public void setDocumentType(@Nullable String documentType)

    • firstName

      public CIPDocument firstName(@Nullable String firstName)

    • getFirstName

      @Nullable public String getFirstName()
      First name extracted from the document
      Returns:
      firstName

    • setFirstName

      public void setFirstName(@Nullable String firstName)

    • gender

      public CIPDocument gender(@Nullable String gender)

    • getGender

      @Nullable public String getGender()
      Gender info extracted from the document
      Returns:
      gender

    • setGender

      public void setGender(@Nullable String gender)

    • id

      public CIPDocument id(@Nonnull String id)

    • getId

      @Nonnull public String getId()
      Your internal ID of check
      Returns:
      id

    • setId

      public void setId(@Nonnull String id)

    • imageIntegrity

      public CIPDocument imageIntegrity(@Nullable String imageIntegrity)

    • getImageIntegrity

      @Nullable public String getImageIntegrity()
      The result of the check. Either `clear` or `consider`.
      Returns:
      imageIntegrity

    • setImageIntegrity

      public void setImageIntegrity(@Nullable String imageIntegrity)

    • imageIntegrityBreakdown

      public CIPDocument imageIntegrityBreakdown(@Nullable String imageIntegrityBreakdown)

    • getImageIntegrityBreakdown

      @Nullable public String getImageIntegrityBreakdown()
      json object representing the results of the various sub-checks done when calculating the result on `image_integrity`. Example: example: {\"colour_picture\": \"clear\", \"conclusive_document_quality\": \"clear\", \"image_quality\": \"clear\", \"supported_document\": \"clear\"}
      Returns:
      imageIntegrityBreakdown

    • setImageIntegrityBreakdown

      public void setImageIntegrityBreakdown(@Nullable String imageIntegrityBreakdown)

    • issuingCountry

      public CIPDocument issuingCountry(@Nullable String issuingCountry)

    • getIssuingCountry

      @Nullable public String getIssuingCountry()
      Country for which issued the document
      Returns:
      issuingCountry

    • setIssuingCountry

      public void setIssuingCountry(@Nullable String issuingCountry)

    • lastName

      public CIPDocument lastName(@Nullable String lastName)

    • getLastName

      @Nullable public String getLastName()
      Last name extracted from the document
      Returns:
      lastName

    • setLastName

      public void setLastName(@Nullable String lastName)

    • nationality

      public CIPDocument nationality(@Nullable String nationality)

    • getNationality

      @Nullable public String getNationality()
      Nationality extracted from the document
      Returns:
      nationality

    • setNationality

      public void setNationality(@Nullable String nationality)

    • policeRecord

      public CIPDocument policeRecord(@Nullable String policeRecord)

    • getPoliceRecord

      @Nullable public String getPoliceRecord()
      An enum representing the status of the CIPInfo \"complete\" \"withdrawn\"
      Returns:
      policeRecord

    • setPoliceRecord

      public void setPoliceRecord(@Nullable String policeRecord)

    • result

      public CIPDocument result(@Nullable String result)

    • getResult

      @Nullable public String getResult()
      The result of the check. Either `clear` or `consider`.
      Returns:
      result

    • setResult

      public void setResult(@Nullable String result)

    • status

      public CIPDocument status(@Nullable String status)

    • getStatus

      @Nullable public String getStatus()
      An enum representing the status of the CIPInfo \"complete\" \"withdrawn\"
      Returns:
      status

    • setStatus

      public void setStatus(@Nullable String status)

    • visualAuthenticity

      public CIPDocument visualAuthenticity(@Nullable String visualAuthenticity)

    • getVisualAuthenticity

      @Nullable public String getVisualAuthenticity()
      json object representing the various sub-checks done when determining whether visual (non-textual) elements are correct given the document type. Example: { \"digital_tampering\": \"clear\", \"face_detection\": \"clear\", \"fonts\": \"clear\", \"original_document_present\": \"clear\", \"picture_face_integrity\": \"clear\", \"security_features\": \"clear\", \"template\": \"clear\"}
      Returns:
      visualAuthenticity

    • setVisualAuthenticity

      public void setVisualAuthenticity(@Nullable String visualAuthenticity)

    • putAdditionalProperty

      public CIPDocument putAdditionalProperty(String key, Object value)
      Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.
      Parameters:
      key - name of the property
      value - value of the property
      Returns:
      the CIPDocument instance itself

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()
      Return the additional (undeclared) property.
      Returns:
      a map of objects

    • getAdditionalProperty

      public Object getAdditionalProperty(String key)
      Return the additional (undeclared) property with the specified name.
      Parameters:
      key - name of the property
      Returns:
      an object

    • 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

    • validateJsonElement

      public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOException
      Validates the JSON Element and throws an exception if issues found
      Parameters:
      jsonElement - JSON Element
      Throws:
      IOException - if the JSON Element is invalid with respect to CIPDocument

    • fromJson

      public static CIPDocument fromJson(String jsonString) throws IOException
      Create an instance of CIPDocument given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of CIPDocument
      Throws:
      IOException - if the JSON string is invalid with respect to CIPDocument

    • toJson

      public String toJson()
      Convert an instance of CIPDocument to an JSON string
      Returns:
      JSON string