Package com.onfido.models
Class Report
- java.lang.Object
-
- com.onfido.models.Report
-
public final class Report extends Object
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classReport.Request
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object o)Map<String,Object>getBreakdown()The details of the report.StringgetCheckId()The ID of the check to which the report belongs.java.time.OffsetDateTimegetCreatedAt()The date and time at which the report was first initiatedList<DocumentId>getDocuments()The document IDs that were processed.StringgetHref()The API endpoint to retrieve the reportStringgetId()The unique identifier for the reportStringgetName()Report type string identifier.Map<String,Object>getProperties()The properties associated with the report, if anyStringgetResult()The result of the reportStringgetStatus()The current state of the report in the checking processStringgetSubResult()The sub_result of the report.inthashCode()static Report.Requestrequest()StringtoString()
-
-
-
Method Detail
-
request
public static Report.Request request()
-
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.
-
-