Class Check


  • public final class Check
    extends Object
    • Method Detail

      • getId

        public String getId()
        The unique identifier for the check. Read-only.
        Returns:
        The unique identifier for the check. Read-only.
      • getCreatedAt

        public java.time.OffsetDateTime getCreatedAt()
        The date and time when this check was created. Read-only.
        Returns:
        The date and time when this check was created. Read-only.
      • getHref

        public String getHref()
        The uri of this resource. Read-only.
        Returns:
        The uri of this resource. Read-only.
      • getStatus

        public String getStatus()
        The current state of the check in the checking process. Read-only.
        Returns:
        The current state of the check in the checking process. Read-only.
      • getResult

        public String getResult()
        The overall result of the check, based on the results of the constituent reports. Read-only.
        Returns:
        The overall result of the check, based on the results of the constituent reports. Read-only.
      • getDownloadUri

        public String getDownloadUri()
        A link to a PDF output of the check results. Append `.pdf` to get the pdf file. Read-only.
        Returns:
        A link to a PDF output of the check results. Append `.pdf` to get the pdf file. Read-only.
      • getFormUri

        public String getFormUri()
        A link to the applicant form, if `applicant_provides_data` is `true`. Read-only.
        Returns:
        A link to the applicant form, if `applicant_provides_data` is `true`. Read-only.
      • getRedirectUri

        public String getRedirectUri()
        For checks where `applicant_provides_data` is `true`, redirect to this URI when the applicant has submitted their data.
        Returns:
        For checks where `applicant_provides_data` is `true`, redirect to this URI when the applicant has submitted their data.
      • getResultsUri

        public String getResultsUri()
        A link to the corresponding results page on the Onfido dashboard.
        Returns:
        A link to the corresponding results page on the Onfido dashboard.
      • getTags

        public List<String> getTags()
        Array of tags being assigned to this check.
        Returns:
        Array of tags being assigned to this check.
      • getApplicantId

        public String getApplicantId()
        The ID of the applicant to do the check on.
        Returns:
        The ID of the applicant to do the check on.
      • getReportIds

        public List<String> getReportIds()
        The list of report object ids associated with the check.
        Returns:
        The list of report object ids associated with the check.
      • getPrivacyNoticesReadConsentGiven

        public Boolean getPrivacyNoticesReadConsentGiven()
        Indicates that the privacy notices and terms of service have been read and, where specific laws require, that consent has been given for Onfido.
        Returns:
        Indicates that the privacy notices and terms of service have been read and, where specific laws require, that consent has been given for Onfido.
      • getWebhookIds

        public List<String> getWebhookIds()
        Array of strings describing which webhooks to trigger for a check.
        Returns:
        Array of strings describing which webhooks to trigger for a check.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object