POST /identity_verification/retry

Default value: "application/json"

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

User information collected outside of Link, most likely via your own onboarding process.

Each of the following identity fields are optional:

email_address

phone_number

date_of_birth

name

address

id_number

Specifically, these fields are optional in that they can either be fully provided (satisfying every required field in their subschema) or omitted from the request entirely by not providing the key or value. Providing these fields via the API will result in Link skipping the data collection process for the associated user. All verification steps enabled in the associated Identity Verification Template will still be run. Verification steps will either be run immediately, or once the user completes the accept_tos step, depending on the value provided to the gave_consent field.

A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).

You can use this field to pre-populate the user's legal name; if it is provided here, they will not be prompted to enter their name in the identity verification attempt.

A string with at least one non-whitespace character, with a max length of 100 characters.

A string with at least one non-whitespace character, with a max length of 100 characters.

A valid email address. Must not have leading or trailing spaces and address must be RFC compliant. For more information, see RFC 3696.

ID number submitted by the user, currently used only for the Identity Verification product. If the user has not submitted this data yet, this field will be null. Otherwise, both fields are guaranteed to be filled.

A globally unique and human readable ID type, specific to the country and document category. For more context on this field, see Hybrid Input Validation.

Possible values:

• "sg_nric"
• "se_pin"
• "cl_run"
• "ke_huduma_namba"
• "ca_sin"
• "es_nie"
• "za_smart_id"
• "ng_nin"
• "es_dni"
• "om_civil_id"
• "ar_dni"
• "jo_civil_id"
• "kw_civil_id"
• "mx_rfc"
• "eg_national_id"
• "dk_cpr"
• "jp_my_number"
• "in_pan"
• "nz_drivers_license"
• "tr_tc_kimlik"
• "cn_resident_card"
• "mx_curp"
• "br_cpf"
• "sa_national_id"
• "us_ssn_last_4"
• "au_passport"
• "co_nit"
• "ph_psn"
• "hk_hkid"
• "pl_pesel"
• "my_nric"
• "ro_cnp"
• "us_ssn"
• "it_cf"
• "au_drivers_license"

Value of identity document value typed in by user. Alpha-numeric, with all formatting characters stripped. For specific format requirements by ID type, see Hybrid Input Validation.

Home address for the user. Supported values are: not provided, address with only country code or full address.

For more context on this field, see Input Validation by Country.

Extra street information, like an apartment or suite number. If provided, a string with at least one non-whitespace character, with a max length of 50 characters.

An ISO 3166-2 subdivision code. Related terms would be "state", "province", "prefecture", "zone", "subdivision", etc.

The postal code for the associated address. Between 2 and 10 alphanumeric characters. For US-based addresses this must be 5 numeric digits.

Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.

The primary street portion of an address. If an address is provided, this field will always be filled. A string with at least one non-whitespace alphabetical character, with a max length of 80 characters.

City from the end user's address. A string with at least one non-whitespace alphabetical character, with a max length of 100 characters."

A valid phone number in E.164 format.

Instructions for the custom retry strategy specifying which steps should be required or skipped.

Note:

This field must be provided when the retry strategy is custom and must be omitted otherwise.

Custom retries override settings in your Plaid Template. For example, if your Plaid Template has verify_sms disabled, a custom retry with verify_sms enabled will still require the step.

The selfie_check step is currently not supported on the sandbox server. Sandbox requests will silently disable the selfie_check step when provided.

A boolean field specifying whether the new session should require or skip the kyc_check (Data Source Verification) step.

A boolean field specifying whether the new session should require or skip the verify_sms step.

A boolean field specifying whether the new session should require or skip the documentary_verification step.

A boolean field specifying whether the new session should require or skip the selfie_check step.

An instruction specifying what steps the new Identity Verification attempt should require the user to complete:

reset - Restart the user at the beginning of the session, regardless of whether they successfully completed part of their previous session.

incomplete - Start the new session at the step that the user failed in the previous session, skipping steps that have already been successfully completed.

infer - If the most recent Identity Verification attempt associated with the given client_user_id has a status of failed or expired, retry using the incomplete strategy. Otherwise, use the reset strategy.

custom - Start the new session with a custom configuration, specified by the value of the steps field

Note:

The incomplete strategy cannot be applied if the session's failing step is screening or risk_check.

The infer strategy cannot be applied if the session's status is still active

Possible values:

• "reset"
• "incomplete"
• "infer"
• "custom"

A flag specifying whether you would like Plaid to expose a shareable URL for the verification being retried. If a value for this flag is not specified, the is_shareable setting from the original verification attempt will be used.

A unique ID that identifies the end user in your system. This ID can also be used to associate user-specific data from other Plaid products. Financial Account Matching requires this field and the /link/token/create client_user_id to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

ID of the associated Identity Verification template.