Post Manual Review Decision

Use the /user/idv/manualReview endpoint to post a manual review decision for a user's identity verification (IDV) session. This endpoint allows you to set the 'manual review' status of an IDV session to either "passed" or "failed" based on your manual review. 'Manual review' must be configured for your product to use this endpoint.

The result of the manual review will update the risk of the IDV session accordingly and is typically the last step before an overall approve or decline decision is made for the corresponding user_create action.

The request completes the full decision: the decision is recorded, and the follow-up processing — the IDV session and action risk update, the needs-decision notification, and the CIP status update when the review produces a final decision — runs before the response is returned. A 200 means the decision and all of that were persisted successfully.

One notification is best-effort and sits outside that guarantee: when the review causes the user's CIP status to change, this endpoint also triggers a separate cipStatusUpdated webhook. A 200 means the CIP status itself was updated, but does not guarantee that webhook was delivered — a delivery failure there is logged and does not fail the request, and cannot be repaired by resubmitting. If your integration depends on that notification arriving, poll or reconcile the user's CIP status directly rather than relying on the webhook alone.

Because the decision is recorded first, an error response can be returned for a decision that was in fact saved. When that happens, resubmit the same idvSessionId and status to finish the outstanding processing — the original reviewer and decision timestamp are preserved, and the decision is not recorded twice. Each resubmission must use a new x-client-request-id, since a repeated request ID is rejected as a duplicate.

Resubmitting a different status is rejected: this endpoint cannot be used to change a decision that has already been made. If the session is later returned to manual review (for example after a verification retry), it is treated as a new review and a fresh decision is recorded normally.

Body Params

POST /v1/user/idv/manualReview Request body

string
required

ID of the Spidr IDV Session. Returned in Create User calls that entail IDV via the spidrIdvSessionId parameter.

string
enum
required

Manual review decision: passed or failed

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json