Use the /user/idv/retry endpoint to retry identity verification (IDV) for a user. This endpoint allows you to trigger a new identity verification session against the specified provider.
You must provide one of the following:
- A
providerAND aproviderIdvSessionId
OR
- An
idvSessionId— which is the Spidr-specific session ID.
Use retryScope to choose how much of the verification to re-run:
-
failed— resume at the step the user failed, keeping the steps they already passed. Whether a session can be resumed is the provider's decision, not ours: a session whose failing step was a screening or a risk check is refused, and the provider may refuse others it cannot resume. A refusal we recognise returns409witherrorCode: "IDV_SESSION_NOT_RESUMABLE"; branch on that code rather than on the message, and retry withall. The provider publishes no stable code for this refusal, so one worded differently reaches you as the provider's own error instead — treat any failure on this scope as a reason to fall back toall. -
all— re-run the whole verification from the start. This is the default.
Which individual steps each scope runs is determined by the IDV template configured for your product, not by the request.