6.1 Submitting for Review and Getting Results

Before requesting review, call:

GET /resources/applicants/{applicantId}/requiredIdDocsStatus

Confirm every required step is fulfilled. Then request review:

POST /resources/applicants/{applicantId}/status/pending

After this call, the applicant is queued for automated or manual review and may be locked for editing until review completes or is reset.

Result Options

Production

Production integrations should use the applicantReviewed webhook for final result handling.

Early Integration

Polling GET /resources/applicants/{applicantId}/status is acceptable during early integration and testing.

Example Completed Response

{
  "reviewStatus": "completed",
  "reviewResult": {
    "reviewAnswer": "GREEN",
    "reviewRejectType": null,
    "rejectLabels": []
  }
}