Retry Identity Verification

post

https://api.sb.spidrsrv.com/ztm/v1/user/idv/retry

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

An idvSessionId — which is the Spidr-specific session ID.

You can also specify the specific step to retry.

Body Params

POST /v1/user/idv/retry Request body

provider

string

enum

The vendor/provider used for identity verification.

Allowed:

idvSessionId

string

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

providerIdvSessionId

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.

idvStepsToRetry

array of strings

required

length ≥ 1

Required array of IDV step types to retry. Valid values are 'doc' (documentary verification), 'nondoc' (non-documentary verification), 'monitoring' (watchlist screening), and 'additional_docs' (additional documents). At least one step must be provided.

idvStepsToRetry*

Allowed:

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200POST /v1/user/idv/retry Positive response

400POST /v1/user/idv/retry Negative response