Class Report


  • public final class Report
    extends Object
    • Method Detail

      • getId

        public String getId()
        The unique identifier for the report
        Returns:
        The unique identifier for the report
      • getCreatedAt

        public java.time.OffsetDateTime getCreatedAt()
        The date and time at which the report was first initiated
        Returns:
        The date and time at which the report was first initiated
      • getName

        public String getName()
        Report type string identifier. See the “Report Types” section of this documentation
        Returns:
        Report type string identifier. See the “Report Types” section of this documentation
      • getStatus

        public String getStatus()
        The current state of the report in the checking process
        Returns:
        The current state of the report in the checking process
      • getHref

        public String getHref()
        The API endpoint to retrieve the report
        Returns:
        The API endpoint to retrieve the report
      • getResult

        public String getResult()
        The result of the report
        Returns:
        The result of the report
      • getSubResult

        public String getSubResult()
        The sub_result of the report. It gives a more detailed result for Document reports only, and will be null otherwise
        Returns:
        The sub_result of the report. It gives a more detailed result for Document reports only, and will be null otherwise
      • getProperties

        public Map<String,​Object> getProperties()
        The properties associated with the report, if any
        Returns:
        The properties associated with the report, if any
      • getBreakdown

        public Map<String,​Object> getBreakdown()
        The details of the report. This is specific to each type of report
        Returns:
        The details of the report. This is specific to each type of report
      • getDocuments

        public List<DocumentId> getDocuments()
        The document IDs that were processed. Populated for Document reports, otherwise an empty array.
        Returns:
        The document IDs that were processed. Populated for Document reports, otherwise an empty array.
      • getCheckId

        public String getCheckId()
        The ID of the check to which the report belongs.
        Returns:
        The ID of the check to which the report belongs.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object