Skip to main content

ReviewEntity

idstringrequired

Unique identifier for the review record.

versionnumberrequired

Revision number of the review, indicating the version of the review record.

statusstringrequired

Current status of the review, representing the outcome of the applicant verification process.

Possible values: [INIT, IN_PROGRESS, INCOMPLETE, REJECTED, APPROVED, COMPLETED, ON_HOLD]

createdAtstring<date-time>

Timestamp indicating when the review was created (ISO 8601 format).

updatedAtstring<date-time>

Timestamp indicating when the review was last updated (ISO 8601 format).

commentstring

Optional comment provided by the reviewer, offering additional context or feedback on the review.

holdDetailsobject

Why the applicant is on hold; meaningful only while status is ON_HOLD

warningsstring

list of verifiocations warnings associated with the review

detailsstring

Additional details and metadata regarding the review, such as warning specifics or duplicate applicant identifiers if applicable.

reviewerIdnumber

Unique identifier of the reviewer who conducted the review.

reviewerFullNamestring

Full name of the reviewer who conducted the review.

statusSetByIdnumber

Unique identifier of the decision maker who set the review status.

statusSetByNamestring

Full name of the decision maker who set the review status.

ReviewEntity
{
"id": "string",
"version": 0,
"status": "INIT",
"createdAt": "2024-07-29T15:51:28.071Z",
"updatedAt": "2024-07-29T15:51:28.071Z",
"comment": "string",
"holdDetails": {},
"warnings": "string",
"details": "string",
"reviewerId": 0,
"reviewerFullName": "string",
"statusSetById": 0,
"statusSetByName": "string"
}