Retry Identity Verification

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 provider AND a providerIdvSessionId

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. Retry with all if that happens.

  • 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.

Body Params

POST /v1/user/idv/retry Request body

string
enum

The vendor/provider used for identity verification.

Allowed:
string

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

string

ID of the provider-specific IDV Session. Returned in Create User calls that entail IDV via the <provider>IdvSessionId parameter. For example, if the provider is plaid, the parameter that houses this value will be named plaidIdvSessionId.

string
enum

How much of the verification to re-run. failed resumes at the step the user failed, keeping steps they already passed; the provider refuses it for a session it cannot resume, in which case retry with all. all re-runs the whole verification from the start. Which individual steps each scope implies is determined by the IDV template, not by the request. Defaults to all.

Allowed:
idvStepsToRetry
array of strings

Deprecated. Superseded by retryScope. The contents no longer select which steps run. If retryScope is also supplied it takes precedence; if this array is the only scope supplied, the retry runs as retryScope: "all". Members are still validated against the allowed values. This field will be removed in a future release.

idvStepsToRetry
Allowed:
Responses

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