Returns information about the documents or separate verification step results.
Overview
Use this method to fetch information about the documents or separate verification step results.
Note
Some rejection types may not affect document status; do not forget to check the overall applicant review status and answer.
Response explained
Each step contains an array of image IDs. You can have more than one image, for example, if two sides of the document were uploaded.
If an applicant is rejected with the FINAL
rejection label within the webhook payload or at the answer from this endpoint, the response from requiredIdDocsStatus
may not provide much useful information. If you need to access moderationComment
or clientComment
for a FINAL
rejection, retrieve this information from the webhook or applicant data payload.
To obtain images with IDs, use this method.
Note
Some steps may not have review results. It depends on the review of other step. e.g.
PROOF_OF_RESIDENCE
step depends on theIDENTITY
step if it exists, soPROOF_OF_RESIDENCE
may not have been checked untilIDENTITY
is approved.