Identity Verification

string

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.

Min length: 1

is_shareable

requiredboolean

A flag specifying whether you would like Plaid to expose a shareable URL for the verification being created.

template_id

requiredstring

ID of the associated Identity Verification template.

gave_consent

requiredboolean

A flag specifying whether the end user has already agreed to a privacy policy specifying that their data will be shared with Plaid for verification purposes.
If gave_consent is set to true, the accept_tos step will be marked as skipped and the end user's session will start at the next step requirement.

Default: false

user

object

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. If you are not using the shareable URL feature, you can optionally provide these fields via /link/token/create instead; both /identity_verification/create and /link/token/create are valid ways to provide this information. Note that if you provide a non-null user data object via /identity_verification/create, any user data fields entered via /link/token/create for the same client_user_id will be ignored when prefilling Link.

string

A valid email address.

Format: email

string

A phone number in E.164 format.

string

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

Format: date

name

object

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.

requiredstring

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

requiredstring

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

object

Home address for the user. For more context on this field, see Input Validation by Country.

requiredstring

The primary street portion of an address. If the user has submitted their address, this field will always be filled.

string

Extra street information, like an apartment or suite number.

city

requiredstring

City from the end user's address

string

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

string

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

requiredstring

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

Min length: 2

object

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.

requiredstring

Value of identity document value typed in by user. Alpha-numeric, with all formatting characters stripped.

type

requiredstring

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: ar_dni, au_drivers_license, au_passport, br_cpf, ca_sin, cl_run, cn_resident_card, co_nit, dk_cpr, eg_national_id, es_dni, es_nie, hk_hkid, in_pan, it_cf, jo_civil_id, jp_my_number, ke_huduma_namba, kw_civil_id, mx_curp, mx_rfc, my_nric, ng_nin, nz_drivers_license, om_civil_id, ph_psn, pl_pesel, ro_cnp, sa_national_id, se_pin, sg_nric, tr_tc_kimlik, us_ssn, us_ssn_last_4, za_smart_id

deprecatedstring

Specifying user.client_user_id is deprecated. Please provide client_user_id at the root level instead.

Min length: 1

string

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.

string

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.

is_idempotent

boolean

An optional flag specifying how you would like Plaid to handle attempts to create an Identity Verification when an Identity Verification already exists for the provided client_user_id and template_id. If idempotency is enabled, Plaid will return the existing Identity Verification. If idempotency is disabled, Plaid will reject the request with a 400 Bad Request status code if an Identity Verification already exists for the supplied client_user_id and template_id.

/identity_verification/create
Select Language
1const request: IdentityVerificationCreateRequest = {
client_user_id: 'user-sandbox-b0e2c4ee-a763-4df5-bfe9-46a46bce993d',
is_shareable: true,
template_id: 'idv_52xR9LKo77r1Np',
gave_consent: true,
user: {
  email_address: 'acharleston@email.com',
  phone_number: '+11234567890',
  date_of_birth: '1975-01-18',
  name: {
    given_name: 'Anna',
    family_name: 'Charleston',
  },
  address: {
    street: '100 Market Street',
    street2: 'Apt 1A',
    city: 'San Francisco',
    region: 'CA',
    postal_code: '94103',
    country: 'US',
  },
  id_number: {
    value: '123456789',
    type: 'us_ssn',
  },
},
27};
28try {
const response = await client.identityVerificationCreate(request);
30} catch (error) {
// handle error
32}

identity_verification/create

Response fields and example

id

string

ID of the associated Identity Verification attempt.

string

Min length: 1

string

An ISO8601 formatted timestamp.

Format: date-time

nullablestring

An ISO8601 formatted timestamp.

Format: date-time

nullablestring

The ID for the Identity Verification preceding this session. This field will only be filled if the current Identity Verification is a retry of a previous attempt.

nullablestring

A shareable URL that can be sent directly to the user to complete verification

object

The resource ID and version number of the template configuring the behavior of a given identity verification.

id

string

ID of the associated Identity Verification template.

integer

Version of the associated Identity Verification template.

user

object

The identity data that was either collected from the user or provided via API in order to perform an identity verification.

nullablestring

A phone number in E.164 format.

nullablestring

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

Format: date

nullablestring

An IPv4 or IPV6 address.

nullablestring

A valid email address.

Format: email

name

nullableobject

The full name provided by the user. If the user has not submitted their name, this field will be null. Otherwise, both fields are guaranteed to be filled.

string

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

string

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

nullableobject

Even if an address has been collected, some fields may be null depending on the region's addressing system. For example:
Addresses from the United Kingdom will not include a region
Addresses from Hong Kong will not include postal code

nullablestring

The primary street portion of an address. If the user has submitted their address, this field will always be filled.

nullablestring

Extra street information, like an apartment or suite number.

city

nullablestring

City from the end user's address

nullablestring

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

nullablestring

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

string

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

Min length: 2

nullableobject

string

Value of identity document value typed in by user. Alpha-numeric, with all formatting characters stripped.

type

string

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.

string

The status of this Identity Verification attempt.
active - The Identity Verification attempt is incomplete. The user may have completed part of the session, but has neither failed or passed.
success - The Identity Verification attempt has completed, passing all steps defined to the associated Identity Verification template
failed - The user failed one or more steps in the session and was told to contact support.
expired - The Identity Verification attempt was active for a long period of time without being completed and was automatically marked as expired. Note that sessions currently do not expire. Automatic expiration is expected to be enabled in the future.
canceled - The Identity Verification attempt was canceled, either via the dashboard by a user, or via API. The user may have completed part of the session, but has neither failed or passed.
pending_review - The Identity Verification attempt template was configured to perform a screening that had one or more hits needing review.

Possible values: active, success, failed, expired, canceled, pending_review

object

Each step will be one of the following values:
active - This step is the user's current step. They are either in the process of completing this step, or they recently closed their Identity Verification attempt while in the middle of this step. Only one step will be marked as active at any given point.
success - The Identity Verification attempt has completed this step.
failed - The user failed this step. This can either call the user to fail the session as a whole, or cause them to fallback to another step depending on how the Identity Verification template is configured. A failed step does not imply a failed session.
waiting_for_prerequisite - The user needs to complete another step first, before they progress to this step. This step may never run, depending on if the user fails an earlier step or if the step is only run as a fallback.
not_applicable - This step will not be run for this session.
skipped - The retry instructions that created this Identity Verification attempt specified that this step should be skipped.
expired - This step had not yet been completed when the Identity Verification attempt as a whole expired.
canceled - The Identity Verification attempt was canceled before the user completed this step.
pending_review - The Identity Verification attempt template was configured to perform a screening that had one or more hits needing review.
manually_approved - The step was manually overridden to pass by a team member in the dashboard.
manually_rejected - The step was manually overridden to fail by a team member in the dashboard.

string

The status of a step in the identity verification process.

Possible values: success, active, failed, waiting_for_prerequisite, not_applicable, skipped, expired, canceled, pending_review, manually_approved, manually_rejected

string

The status of a step in the identity verification process.

Possible values: success, active, failed, waiting_for_prerequisite, not_applicable, skipped, expired, canceled, pending_review, manually_approved, manually_rejected

string

The status of a step in the identity verification process.

Possible values: success, active, failed, waiting_for_prerequisite, not_applicable, skipped, expired, canceled, pending_review, manually_approved, manually_rejected

string

The status of a step in the identity verification process.

Possible values: success, active, failed, waiting_for_prerequisite, not_applicable, skipped, expired, canceled, pending_review, manually_approved, manually_rejected

string

The status of a step in the identity verification process.

Possible values: success, active, failed, waiting_for_prerequisite, not_applicable, skipped, expired, canceled, pending_review, manually_approved, manually_rejected

string

The status of a step in the identity verification process.

Possible values: success, active, failed, waiting_for_prerequisite, not_applicable, skipped, expired, canceled, pending_review, manually_approved, manually_rejected

string

The status of a step in the identity verification process.

Possible values: success, active, failed, waiting_for_prerequisite, not_applicable, skipped, expired, canceled, pending_review, manually_approved, manually_rejected

nullableobject

Data, images, analysis, and results from the documentary_verification step. This field will be null unless steps.documentary_verification has reached a terminal state of either success or failed.

string

The outcome status for the associated Identity Verification attempt's documentary_verification step. This field will always have the same value as steps.documentary_verification.

documents

[object]

An array of documents submitted to the documentary_verification step. Each entry represents one user submission, where each submission will contain both a front and back image, or just a front image, depending on the document type.
Note: Plaid will automatically let a user submit a new set of document images up to three times if we detect that a previous attempt might have failed due to user error. For example, if the first set of document images are blurry or obscured by glare, the user will be asked to capture their documents again, resulting in at least two separate entries within documents. If the overall documentary_verification is failed, the user has exhausted their retry attempts.

string

An outcome status for this specific document submission. Distinct from the overall documentary_verification.status that summarizes the verification outcome from one or more documents.

Possible values: success, failed, manually_approved

integer

The attempt field begins with 1 and increments with each subsequent document upload.

images

object

URLs for downloading original and cropped images for this document submission. The URLs are designed to only allow downloading, not hot linking, so the URL will only serve the document image for 60 seconds before expiring. The expiration time is 60 seconds after the GET request for the associated Identity Verification attempt. A new expiring URL is generated with each request, so you can always rerequest the Identity Verification attempt if one of your URLs expires.

original_front

nullablestring

Temporary URL that expires after 60 seconds for downloading the uncropped original image of the front of the document.

original_back

nullablestring

Temporary URL that expires after 60 seconds for downloading the original image of the back of the document. Might be null if the back of the document was not collected.

cropped_front

nullablestring

Temporary URL that expires after 60 seconds for downloading a cropped image containing just the front of the document.

cropped_back

nullablestring

Temporary URL that expires after 60 seconds for downloading a cropped image containing just the back of the document. Might be null if the back of the document was not collected.

face

nullablestring

Temporary URL that expires after 60 seconds for downloading a crop of just the user's face from the document image. Might be null if the document does not contain a face photo.

nullableobject

Data extracted from a user-submitted document.

nullablestring

Alpha-numeric ID number extracted via OCR from the user's document image.

category

string

The type of identity document detected in the images provided. Will always be one of the following values:
drivers_license - A driver's license issued by the associated country, establishing identity without any guarantee as to citizenship, and granting driving privileges
id_card - A general national identification card, distinct from driver's licenses as it only establishes identity
passport - A travel passport issued by the associated country for one of its citizens
residence_permit_card - An identity document issued by the associated country permitting a foreign citizen to temporarily reside there
resident_card - An identity document issued by the associated country permitting a foreign citizen to permanently reside there
visa - An identity document issued by the associated country permitting a foreign citizen entry for a short duration and for a specific purpose, typically no longer than 6 months
Note: This value may be different from the ID type that the user selects within Link. For example, if they select "Driver's License" but then submit a picture of a passport, this field will say passport

Possible values: drivers_license, id_card, passport, residence_permit_card, resident_card, visa

nullablestring

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

Format: date

string

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

Min length: 2

issuing_region

nullablestring

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

nullablestring

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

Format: date

nullableobject

The address extracted from the document. The address must at least contain the following fields to be a valid address: street, city, country. If any are missing or unable to be extracted, the address will be null.
region, and postal_code may be null based on the addressing system. For example:
Addresses from the United Kingdom will not include a region
Addresses from Hong Kong will not include postal code
Note: Optical Character Recognition (OCR) technology may sometimes extract incorrect data from a document.

string

The full street address extracted from the document.

city

string

City extracted from the document.

nullablestring

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

nullablestring

The postal code extracted from the document. Between 2 and 10 alphanumeric characters. For US-based addresses this must be 5 numeric digits.

string

Valid, capitalized, two-letter ISO code representing the country extracted from the document. Must be in ISO 3166-1 alpha-2 form.

Min length: 2

object

High level descriptions of how the associated document was processed. If a document fails verification, the details in the analysis object should help clarify why the document was rejected.

authenticity

string

High level summary of whether the document in the provided image matches the formatting rules and security checks for the associated jurisdiction.
For example, most identity documents have formatting rules like the following:
The image of the person's face must have a certain contrast in order to highlight skin tone
The subject in the document's image must remove eye glasses and pose in a certain way
The informational fields (name, date of birth, ID number, etc.) must be colored and aligned according to specific rules
Security features like watermarks and background patterns must be present
So a match status for this field indicates that the document in the provided image seems to conform to the various formatting and security rules associated with the detected document.

Possible values: match, partial_match, no_match, no_data

image_quality

string

A high level description of the quality of the image the user submitted.
For example, an image that is blurry, distorted by glare from a nearby light source, or improperly framed might be marked as low or medium quality. Poor quality images are more likely to fail OCR and/or template conformity checks.
Note: By default, Plaid will let a user recapture document images twice before failing the entire session if we attribute the failure to low image quality.

Possible values: high, medium, low

nullableobject

Analysis of the data extracted from the submitted document.

name

string

A match summary describing the cross comparison between the subject's name, extracted from the document image, and the name they separately provided to identity verification attempt.

Possible values: match, partial_match, no_match

string

A match summary describing the cross comparison between the subject's date of birth, extracted from the document image, and the date of birth they separately provided to the identity verification attempt.

Possible values: match, partial_match, no_match

string

A description of whether the associated document was expired when the verification was performed.
Note: In the case where an expiration date is not present on the document or failed to be extracted, this value will be no_data.

Possible values: not_expired, expired, no_data

string

A binary match indicator specifying whether the country that issued the provided document matches the country that the user separately provided to Plaid.
Note: You can configure whether a no_match on issuing_country fails the documentary_verification by editing your Plaid Template.

Possible values: match, no_match

nullablestring

An ISO8601 formatted timestamp.

Format: date-time

nullableobject

Additional information for the selfie_check step. This field will be null unless steps.selfie_check has reached a terminal state of either success or failed.

string

The outcome status for the associated Identity Verification attempt's selfie_check step. This field will always have the same value as steps.selfie_check.

Possible values: success, failed

selfies

[object]

An array of selfies submitted to the selfie_check step. Each entry represents one user submission.

string

An outcome status for this specific selfie. Distinct from the overall selfie_check.status that summarizes the verification outcome from one or more selfies.

Possible values: success, failed

integer

The attempt field begins with 1 and increments with each subsequent selfie upload.

capture

object

The image or video capture of a selfie. Only one of image or video URL will be populated per selfie.

image_url

nullablestring

Temporary URL for downloading an image selfie capture.

video_url

nullablestring

Temporary URL for downloading a video selfie capture.

object

High level descriptions of how the associated selfie was processed. If a selfie fails verification, the details in the analysis object should help clarify why the selfie was rejected.

document_comparison

string

Information about the comparison between the selfie and the document (if documentary verification also ran).

Possible values: match, no_match, no_input

nullableobject

Additional information for the kyc_check step. This field will be null unless steps.kyc_check has reached a terminal state of either success or failed.

string

The outcome status for the associated Identity Verification attempt's kyc_check step. This field will always have the same value as steps.kyc_check.

object

Result summary object specifying how the address field matched.

string

An enum indicating the match type between data provided by user and data checked against an external data source.
match indicates that the provided input data was a strong match against external data.
partial_match indicates the data approximately matched against external data. For example, "Knope" vs. "Knope-Wyatt" for last name.
no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.
no_data indicates that Plaid was unable to find external data to compare against the provided input data.
no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

Possible values: match, partial_match, no_match, no_data, no_input

po_box

string

Field describing whether the associated address is a post office box. Will be yes when a P.O. box is detected, no when Plaid confirmed the address is not a P.O. box, and no_data when Plaid was not able to determine if the address is a P.O. box.

Possible values: yes, no, no_data

type

string

Field describing whether the associated address is being used for commercial or residential purposes.
Note: This value will be no_data when Plaid does not have sufficient data to determine the address's use.

Possible values: residential, commercial, no_data

name

object

Result summary object specifying how the name field matched.

string

Possible values: match, partial_match, no_match, no_data, no_input

object

Result summary object specifying how the date_of_birth field matched.

string

Possible values: match, partial_match, no_match, no_data, no_input

object

Result summary object specifying how the id_number field matched.

string

Possible values: match, partial_match, no_match, no_data, no_input

object

Result summary object specifying how the phone field matched.

string

Possible values: match, partial_match, no_match, no_data, no_input

area_code

string

Possible values: match, partial_match, no_match, no_data, no_input

nullableobject

Additional information for the risk_check step.

domain_is_free_provider

string

The status of a step in the identity verification process.

Possible values: success, active, failed, waiting_for_prerequisite, not_applicable, skipped, expired, canceled, pending_review, manually_approved, manually_rejected

behavior

nullableobject

Result summary object specifying values for behavior attributes of risk check, when available.

user_interactions

string

Field describing the overall user interaction signals of a behavior risk check. This value represents how familiar the user is with the personal data they provide, based on a number of signals that are collected during their session.
genuine indicates the user has high familiarity with the data they are providing, and that fraud is unlikely.
neutral indicates some signals are present in between risky and genuine, but there are not enough clear signals to determine an outcome.
risky indicates the user has low familiarity with the data they are providing, and that fraud is likely.
no_data indicates there is not sufficient information to give an accurate signal.

Possible values: genuine, neutral, risky, no_data

fraud_ring_detected

string

Field describing the outcome of a fraud ring behavior risk check.
yes indicates that fraud ring activity was detected.
no indicates that fraud ring activity was not detected.
no_data indicates there was not enough information available to give an accurate signal.

Possible values: yes, no, no_data

bot_detected

string

Field describing the outcome of a bot detection behavior risk check.
yes indicates that automated activity was detected.
no indicates that automated activity was not detected.
no_data indicates there was not enough information available to give an accurate signal.

Possible values: yes, no, no_data

email

nullableobject

Result summary object specifying values for email attributes of risk check.

is_deliverable

string

SMTP-MX check to confirm the email address exists if known.

Possible values: yes, no, no_data

breach_count

nullableinteger

Count of all known breaches of this email address if known.

first_breached_at

nullablestring

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

Format: date

last_breached_at

nullablestring

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

Format: date

domain_registered_at

nullablestring

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

Format: date

string

Indicates whether the email address domain is a free provider such as Gmail or Hotmail if known.

Possible values: yes, no, no_data

domain_is_custom

string

Indicates whether the email address domain is custom if known, i.e. a company domain and not free or disposable.

Possible values: yes, no, no_data

domain_is_disposable

string

Indicates whether the email domain is listed as disposable if known. Disposable domains are often used to create email addresses that are part of a fake set of user details.

Possible values: yes, no, no_data

top_level_domain_is_suspicious

string

Indicates whether the email address top level domain, which is the last part of the domain, is fraudulent or risky if known. In most cases, a suspicious top level domain is also associated with a disposable or high-risk domain.

Possible values: yes, no, no_data

[string]

A list of online services where this email address has been detected to have accounts or other activity.

Possible values: apple, ebay, facebook, flickr, foursquare, github, google, gravatar, instagram, lastfm, linkedin, microsoft, myspace, pinterest, skype, spotify, telegram, tumblr, twitter, viber, vimeo, weibo, whatsapp, yahoo, airbnb, amazon, booking, discord, kakao, ok, qzone, line, snapchat, zalo

phone

nullableobject

Result summary object specifying values for phone attributes of risk check.

[string]

A list of online services where this phone number has been detected to have accounts or other activity.

devices

[object]

Array of result summary objects specifying values for device attributes of risk check.

ip_proxy_type

nullablestring

An enum indicating whether a network proxy is present and if so what type it is.
none_detected indicates the user is not on a detectable proxy network.
tor indicates the user was using a Tor browser, which sends encrypted traffic on a decentralized network and is somewhat similar to a VPN (Virtual Private Network).
vpn indicates the user is on a VPN (Virtual Private Network)
web_proxy indicates the user is on a web proxy server, which may allow them to conceal information such as their IP address or other identifying information.
public_proxy indicates the user is on a public web proxy server, which is similar to a web proxy but can be shared by multiple users. This may allow multiple users to appear as if they have the same IP address for instance.

Possible values: none_detected, tor, vpn, web_proxy, public_proxy

ip_spam_list_count

nullableinteger

Count of spam lists the IP address is associated with if known.

ip_timezone_offset

nullablestring

UTC offset of the timezone associated with the IP address.

identity_abuse_signals

nullableobject

Result summary object capturing abuse signals related to identity abuse, e.g. stolen and synthetic identity fraud.

synthetic_identity

nullableobject

Field containing the data used in determining the outcome of the synthetic identity risk check.
Contains the following fields:
score - A score from 0 to 100 indicating the likelihood that the user is a synthetic identity.

integer

A score from 0 to 100 indicating the likelihood that the user is a synthetic identity.

stolen_identity

nullableobject

Field containing the data used in determining the outcome of the stolen identity risk check.
Contains the following fields:
score - A score from 0 to 100 indicating the likelihood that the user is a stolen identity.

integer

A score from 0 to 100 indicating the likelihood that the user is a stolen identity.

watchlist_screening_id

nullablestring

ID of the associated screening.

identity_verification_id

nullablestring

An ISO8601 formatted timestamp.

Format: date-time

request_id

string

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

API Object
1{
"id": "idv_52xR9LKo77r1Np",
"client_user_id": "your-db-id-3b24110",
"created_at": "2020-07-24T03:26:02Z",
"completed_at": "2020-07-24T03:26:02Z",
"previous_attempt_id": "idv_42cF1MNo42r9Xj",
"shareable_url": "https://flow.plaid.com/verify/idv_4FrXJvfQU3zGUR?key=e004115db797f7cc3083bff3167cba30644ef630fb46f5b086cde6cc3b86a36f",
"template": {
  "id": "idvtmp_4FrXJvfQU3zGUR",
  "version": 2
},
"user": {
  "phone_number": "+19876543212",
  "date_of_birth": "1990-05-29",
  "ip_address": "192.0.2.42",
  "email_address": "user@example.com",
  "name": {
    "given_name": "Leslie",
    "family_name": "Knope"
  },
  "address": {
    "street": "123 Main St.",
    "street2": "Unit 42",
    "city": "Pawnee",
    "region": "IN",
    "postal_code": "46001",
    "country": "US"
  },
  "id_number": {
    "value": "123456789",
    "type": "us_ssn"
  }
},
"status": "success",
"steps": {
  "accept_tos": "success",
  "verify_sms": "success",
  "kyc_check": "success",
  "documentary_verification": "success",
  "selfie_check": "success",
  "watchlist_screening": "success",
  "risk_check": "success"
},
"documentary_verification": {
  "status": "success",
  "documents": [
    {
      "status": "success",
      "attempt": 1,
      "images": {
        "original_front": "https://example.plaid.com/verifications/idv_52xR9LKo77r1Np/documents/1/original_front.jpeg",
        "original_back": "https://example.plaid.com/verifications/idv_52xR9LKo77r1Np/documents/1/original_back.jpeg",
        "cropped_front": "https://example.plaid.com/verifications/idv_52xR9LKo77r1Np/documents/1/cropped_front.jpeg",
        "cropped_back": "https://example.plaid.com/verifications/idv_52xR9LKo77r1Np/documents/1/cropped_back.jpeg",
        "face": "https://example.plaid.com/verifications/idv_52xR9LKo77r1Np/documents/1/face.jpeg"
      },
      "extracted_data": {
        "id_number": "AB123456",
        "category": "drivers_license",
        "expiration_date": "1990-05-29",
        "issuing_country": "US",
        "issuing_region": "IN",
        "date_of_birth": "1990-05-29",
        "address": {
          "street": "123 Main St. Unit 42",
          "city": "Pawnee",
          "region": "IN",
          "postal_code": "46001",
          "country": "US"
        }
      },
      "analysis": {
        "authenticity": "match",
        "image_quality": "high",
        "extracted_data": {
          "name": "match",
          "date_of_birth": "match",
          "expiration_date": "not_expired",
          "issuing_country": "match"
        }
      },
      "redacted_at": "2020-07-24T03:26:02Z"
    }
  ]
},
"selfie_check": {
  "status": "success",
  "selfies": [
    {
      "status": "success",
      "attempt": 1,
      "capture": {
        "image_url": "https://example.plaid.com/verifications/idv_52xR9LKo77r1Np/selfie/liveness.jpeg",
        "video_url": "https://example.plaid.com/verifications/idv_52xR9LKo77r1Np/selfie/liveness.webm"
      },
      "analysis": {
        "document_comparison": "match"
      }
    }
  ]
},
"kyc_check": {
  "status": "success",
  "address": {
    "summary": "match",
    "po_box": "yes",
    "type": "residential"
  },
  "name": {
    "summary": "match"
  },
  "date_of_birth": {
    "summary": "match"
  },
  "id_number": {
    "summary": "match"
  },
  "phone_number": {
    "summary": "match",
    "area_code": "match"
  }
},
"risk_check": {
  "status": "success",
  "behavior": {
    "user_interactions": "risky",
    "fraud_ring_detected": "yes",
    "bot_detected": "yes"
  },
  "email": {
    "is_deliverable": "yes",
    "breach_count": 1,
    "first_breached_at": "1990-05-29",
    "last_breached_at": "1990-05-29",
    "domain_registered_at": "1990-05-29",
    "domain_is_free_provider": "yes",
    "domain_is_custom": "yes",
    "domain_is_disposable": "yes",
    "top_level_domain_is_suspicious": "yes",
    "linked_services": [
      "apple"
    ]
  },
  "phone": {
    "linked_services": [
      "apple"
    ]
  },
  "devices": [
    {
      "ip_proxy_type": "none_detected",
      "ip_spam_list_count": 1,
      "ip_timezone_offset": "+06:00:00"
    }
  ],
  "identity_abuse_signals": {
    "synthetic_identity": {
      "score": 0
    },
    "stolen_identity": {
      "score": 0
    }
  }
},
"watchlist_screening_id": "scr_52xR9LKo77r1Np",
"redacted_at": "2020-07-24T03:26:02Z",
"request_id": "saKrIBuEB9qJZng"
168}

Was this helpful?

`/identity_verification/get`

Retrieve Identity Verification

Retrieve a previously created identity verification.

identity_verification/get

Request fields and example

requiredstring

ID of the associated Identity Verification attempt.

string

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.

string

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.

/identity_verification/get
Select Language
1const request: IdentityVerificationGetRequest = {
2  identity_verification_id: 'idv_52xR9LKo77r1Np',
3};
4try {
5  const response = await plaidClient.identityVerificationGet(request);
6} catch (error) {
7  // handle error
8}

identity_verification/get

Response fields and example

id

string

ID of the associated Identity Verification attempt.

string

Min length: 1

string

An ISO8601 formatted timestamp.

Format: date-time

nullablestring

An ISO8601 formatted timestamp.

Format: date-time

nullablestring

The ID for the Identity Verification preceding this session. This field will only be filled if the current Identity Verification is a retry of a previous attempt.

nullablestring

A shareable URL that can be sent directly to the user to complete verification

object

The resource ID and version number of the template configuring the behavior of a given identity verification.

id

string

ID of the associated Identity Verification template.

integer

Version of the associated Identity Verification template.

user

object

The identity data that was either collected from the user or provided via API in order to perform an identity verification.

nullablestring

A phone number in E.164 format.

nullablestring

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

Format: date

nullablestring

An IPv4 or IPV6 address.

nullablestring

A valid email address.

Format: email

name

nullableobject

The full name provided by the user. If the user has not submitted their name, this field will be null. Otherwise, both fields are guaranteed to be filled.

string

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

string

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

nullableobject

nullablestring

The primary street portion of an address. If the user has submitted their address, this field will always be filled.

nullablestring

Extra street information, like an apartment or suite number.

city

nullablestring

City from the end user's address

nullablestring

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

nullablestring

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

string

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

Min length: 2

nullableobject

string

Value of identity document value typed in by user. Alpha-numeric, with all formatting characters stripped.

type

string

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.

string

Possible values: active, success, failed, expired, canceled, pending_review

object

string

The status of a step in the identity verification process.

Possible values: success, active, failed, waiting_for_prerequisite, not_applicable, skipped, expired, canceled, pending_review, manually_approved, manually_rejected

string

The status of a step in the identity verification process.

Possible values: success, active, failed, waiting_for_prerequisite, not_applicable, skipped, expired, canceled, pending_review, manually_approved, manually_rejected

string

The status of a step in the identity verification process.

Possible values: success, active, failed, waiting_for_prerequisite, not_applicable, skipped, expired, canceled, pending_review, manually_approved, manually_rejected

string

The status of a step in the identity verification process.

Possible values: success, active, failed, waiting_for_prerequisite, not_applicable, skipped, expired, canceled, pending_review, manually_approved, manually_rejected

string

The status of a step in the identity verification process.

Possible values: success, active, failed, waiting_for_prerequisite, not_applicable, skipped, expired, canceled, pending_review, manually_approved, manually_rejected

string

The status of a step in the identity verification process.

Possible values: success, active, failed, waiting_for_prerequisite, not_applicable, skipped, expired, canceled, pending_review, manually_approved, manually_rejected

string

The status of a step in the identity verification process.

Possible values: success, active, failed, waiting_for_prerequisite, not_applicable, skipped, expired, canceled, pending_review, manually_approved, manually_rejected

nullableobject

string

The outcome status for the associated Identity Verification attempt's documentary_verification step. This field will always have the same value as steps.documentary_verification.

documents

[object]

string

An outcome status for this specific document submission. Distinct from the overall documentary_verification.status that summarizes the verification outcome from one or more documents.

Possible values: success, failed, manually_approved

integer

The attempt field begins with 1 and increments with each subsequent document upload.

images

object

original_front

nullablestring

Temporary URL that expires after 60 seconds for downloading the uncropped original image of the front of the document.

original_back

nullablestring

Temporary URL that expires after 60 seconds for downloading the original image of the back of the document. Might be null if the back of the document was not collected.

cropped_front

nullablestring

Temporary URL that expires after 60 seconds for downloading a cropped image containing just the front of the document.

cropped_back

nullablestring

Temporary URL that expires after 60 seconds for downloading a cropped image containing just the back of the document. Might be null if the back of the document was not collected.

face

nullablestring

Temporary URL that expires after 60 seconds for downloading a crop of just the user's face from the document image. Might be null if the document does not contain a face photo.

nullableobject

Data extracted from a user-submitted document.

nullablestring

Alpha-numeric ID number extracted via OCR from the user's document image.

category

string

Possible values: drivers_license, id_card, passport, residence_permit_card, resident_card, visa

nullablestring

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

Format: date

string

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

Min length: 2

issuing_region

nullablestring

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

nullablestring

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

Format: date

nullableobject

string

The full street address extracted from the document.

city

string

City extracted from the document.

nullablestring

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

nullablestring

The postal code extracted from the document. Between 2 and 10 alphanumeric characters. For US-based addresses this must be 5 numeric digits.

string

Valid, capitalized, two-letter ISO code representing the country extracted from the document. Must be in ISO 3166-1 alpha-2 form.

Min length: 2

object

High level descriptions of how the associated document was processed. If a document fails verification, the details in the analysis object should help clarify why the document was rejected.

authenticity

string

Possible values: match, partial_match, no_match, no_data

image_quality

string

Possible values: high, medium, low

nullableobject

Analysis of the data extracted from the submitted document.

name

string

A match summary describing the cross comparison between the subject's name, extracted from the document image, and the name they separately provided to identity verification attempt.

Possible values: match, partial_match, no_match

string

Possible values: match, partial_match, no_match

string

Possible values: not_expired, expired, no_data

string

Possible values: match, no_match

nullablestring

An ISO8601 formatted timestamp.

Format: date-time

nullableobject

Additional information for the selfie_check step. This field will be null unless steps.selfie_check has reached a terminal state of either success or failed.

string

The outcome status for the associated Identity Verification attempt's selfie_check step. This field will always have the same value as steps.selfie_check.

Possible values: success, failed

selfies

[object]

An array of selfies submitted to the selfie_check step. Each entry represents one user submission.

string

An outcome status for this specific selfie. Distinct from the overall selfie_check.status that summarizes the verification outcome from one or more selfies.

Possible values: success, failed

integer

The attempt field begins with 1 and increments with each subsequent selfie upload.

capture

object

The image or video capture of a selfie. Only one of image or video URL will be populated per selfie.

image_url

nullablestring

Temporary URL for downloading an image selfie capture.

video_url

nullablestring

Temporary URL for downloading a video selfie capture.

object

High level descriptions of how the associated selfie was processed. If a selfie fails verification, the details in the analysis object should help clarify why the selfie was rejected.

document_comparison

string

Information about the comparison between the selfie and the document (if documentary verification also ran).

Possible values: match, no_match, no_input

nullableobject

Additional information for the kyc_check step. This field will be null unless steps.kyc_check has reached a terminal state of either success or failed.

string

The outcome status for the associated Identity Verification attempt's kyc_check step. This field will always have the same value as steps.kyc_check.

object

Result summary object specifying how the address field matched.

string

Possible values: match, partial_match, no_match, no_data, no_input

po_box

string

Possible values: yes, no, no_data

type

string

Possible values: residential, commercial, no_data

name

object

Result summary object specifying how the name field matched.

string

Possible values: match, partial_match, no_match, no_data, no_input

object

Result summary object specifying how the date_of_birth field matched.

string

Possible values: match, partial_match, no_match, no_data, no_input

object

Result summary object specifying how the id_number field matched.

string

Possible values: match, partial_match, no_match, no_data, no_input

object

Result summary object specifying how the phone field matched.

string

Possible values: match, partial_match, no_match, no_data, no_input

area_code

string

Possible values: match, partial_match, no_match, no_data, no_input

nullableobject

Additional information for the risk_check step.

domain_is_free_provider

string

The status of a step in the identity verification process.

Possible values: success, active, failed, waiting_for_prerequisite, not_applicable, skipped, expired, canceled, pending_review, manually_approved, manually_rejected

behavior

nullableobject

Result summary object specifying values for behavior attributes of risk check, when available.

user_interactions

string

Possible values: genuine, neutral, risky, no_data

fraud_ring_detected

string

Possible values: yes, no, no_data

bot_detected

string

Possible values: yes, no, no_data

email

nullableobject

Result summary object specifying values for email attributes of risk check.

is_deliverable

string

SMTP-MX check to confirm the email address exists if known.

Possible values: yes, no, no_data

breach_count

nullableinteger

Count of all known breaches of this email address if known.

first_breached_at

nullablestring

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

Format: date

last_breached_at

nullablestring

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

Format: date

domain_registered_at

nullablestring

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

Format: date

string

Indicates whether the email address domain is a free provider such as Gmail or Hotmail if known.

Possible values: yes, no, no_data

domain_is_custom

string

Indicates whether the email address domain is custom if known, i.e. a company domain and not free or disposable.

Possible values: yes, no, no_data

domain_is_disposable

string

Indicates whether the email domain is listed as disposable if known. Disposable domains are often used to create email addresses that are part of a fake set of user details.

Possible values: yes, no, no_data

top_level_domain_is_suspicious

string

Possible values: yes, no, no_data

[string]

A list of online services where this email address has been detected to have accounts or other activity.

phone

nullableobject

Result summary object specifying values for phone attributes of risk check.

[string]

A list of online services where this phone number has been detected to have accounts or other activity.

devices

[object]

Array of result summary objects specifying values for device attributes of risk check.

ip_proxy_type

nullablestring

Possible values: none_detected, tor, vpn, web_proxy, public_proxy

ip_spam_list_count

nullableinteger

Count of spam lists the IP address is associated with if known.

ip_timezone_offset

nullablestring

UTC offset of the timezone associated with the IP address.

identity_abuse_signals

nullableobject

Result summary object capturing abuse signals related to identity abuse, e.g. stolen and synthetic identity fraud.

synthetic_identity

nullableobject

integer

A score from 0 to 100 indicating the likelihood that the user is a synthetic identity.

stolen_identity

nullableobject

integer

A score from 0 to 100 indicating the likelihood that the user is a stolen identity.

watchlist_screening_id

nullablestring

ID of the associated screening.

nullablestring

An ISO8601 formatted timestamp.

Format: date-time

request_id

string

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

API Object
1{
"id": "idv_52xR9LKo77r1Np",
"client_user_id": "your-db-id-3b24110",
"created_at": "2020-07-24T03:26:02Z",
"completed_at": "2020-07-24T03:26:02Z",
"previous_attempt_id": "idv_42cF1MNo42r9Xj",
"shareable_url": "https://flow.plaid.com/verify/idv_4FrXJvfQU3zGUR?key=e004115db797f7cc3083bff3167cba30644ef630fb46f5b086cde6cc3b86a36f",
"template": {
  "id": "idvtmp_4FrXJvfQU3zGUR",
  "version": 2
},
"user": {
  "phone_number": "+19876543212",
  "date_of_birth": "1990-05-29",
  "ip_address": "192.0.2.42",
  "email_address": "user@example.com",
  "name": {
    "given_name": "Leslie",
    "family_name": "Knope"
  },
  "address": {
    "street": "123 Main St.",
    "street2": "Unit 42",
    "city": "Pawnee",
    "region": "IN",
    "postal_code": "46001",
    "country": "US"
  },
  "id_number": {
    "value": "123456789",
    "type": "us_ssn"
  }
},
"status": "success",
"steps": {
  "accept_tos": "success",
  "verify_sms": "success",
  "kyc_check": "success",
  "documentary_verification": "success",
  "selfie_check": "success",
  "watchlist_screening": "success",
  "risk_check": "success"
},
"documentary_verification": {
  "status": "success",
  "documents": [
    {
      "status": "success",
      "attempt": 1,
      "images": {
        "original_front": "https://example.plaid.com/verifications/idv_52xR9LKo77r1Np/documents/1/original_front.jpeg",
        "original_back": "https://example.plaid.com/verifications/idv_52xR9LKo77r1Np/documents/1/original_back.jpeg",
        "cropped_front": "https://example.plaid.com/verifications/idv_52xR9LKo77r1Np/documents/1/cropped_front.jpeg",
        "cropped_back": "https://example.plaid.com/verifications/idv_52xR9LKo77r1Np/documents/1/cropped_back.jpeg",
        "face": "https://example.plaid.com/verifications/idv_52xR9LKo77r1Np/documents/1/face.jpeg"
      },
      "extracted_data": {
        "id_number": "AB123456",
        "category": "drivers_license",
        "expiration_date": "1990-05-29",
        "issuing_country": "US",
        "issuing_region": "IN",
        "date_of_birth": "1990-05-29",
        "address": {
          "street": "123 Main St. Unit 42",
          "city": "Pawnee",
          "region": "IN",
          "postal_code": "46001",
          "country": "US"
        }
      },
      "analysis": {
        "authenticity": "match",
        "image_quality": "high",
        "extracted_data": {
          "name": "match",
          "date_of_birth": "match",
          "expiration_date": "not_expired",
          "issuing_country": "match"
        }
      },
      "redacted_at": "2020-07-24T03:26:02Z"
    }
  ]
},
"selfie_check": {
  "status": "success",
  "selfies": [
    {
      "status": "success",
      "attempt": 1,
      "capture": {
        "image_url": "https://example.plaid.com/verifications/idv_52xR9LKo77r1Np/selfie/liveness.jpeg",
        "video_url": "https://example.plaid.com/verifications/idv_52xR9LKo77r1Np/selfie/liveness.webm"
      },
      "analysis": {
        "document_comparison": "match"
      }
    }
  ]
},
"kyc_check": {
  "status": "success",
  "address": {
    "summary": "match",
    "po_box": "yes",
    "type": "residential"
  },
  "name": {
    "summary": "match"
  },
  "date_of_birth": {
    "summary": "match"
  },
  "id_number": {
    "summary": "match"
  },
  "phone_number": {
    "summary": "match",
    "area_code": "match"
  }
},
"risk_check": {
  "status": "success",
  "behavior": {
    "user_interactions": "risky",
    "fraud_ring_detected": "yes",
    "bot_detected": "yes"
  },
  "email": {
    "is_deliverable": "yes",
    "breach_count": 1,
    "first_breached_at": "1990-05-29",
    "last_breached_at": "1990-05-29",
    "domain_registered_at": "1990-05-29",
    "domain_is_free_provider": "yes",
    "domain_is_custom": "yes",
    "domain_is_disposable": "yes",
    "top_level_domain_is_suspicious": "yes",
    "linked_services": [
      "apple"
    ]
  },
  "phone": {
    "linked_services": [
      "apple"
    ]
  },
  "devices": [
    {
      "ip_proxy_type": "none_detected",
      "ip_spam_list_count": 1,
      "ip_timezone_offset": "+06:00:00"
    }
  ],
  "identity_abuse_signals": {
    "synthetic_identity": {
      "score": 0
    },
    "stolen_identity": {
      "score": 0
    }
  }
},
"watchlist_screening_id": "scr_52xR9LKo77r1Np",
"redacted_at": "2020-07-24T03:26:02Z",
"request_id": "saKrIBuEB9qJZng"
168}

Was this helpful?

`/identity_verification/list`

List Identity Verifications

Filter and list Identity Verifications created by your account

identity_verification/list

Request fields and example

string

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.

string

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.

template_id

requiredstring

ID of the associated Identity Verification template.

requiredstring

Min length: 1

cursor

string

An identifier that determines which page of results you receive.

/identity_verification/list
Select Language
1const request: ListIdentityVerificationRequest = {
2  template_id: 'idv_52xR9LKo77r1Np',
3  client_user_id: 'user-sandbox-b0e2c4ee-a763-4df5-bfe9-46a46bce993d',
4};
5try {
6  const response = await plaidClient.identityVerificationList(request);
7} catch (error) {
8  // handle error
9}

identity_verification/list

Response fields and example

identity_verifications

[object]

List of Plaid sessions

id

string

ID of the associated Identity Verification attempt.

string

Min length: 1

string

An ISO8601 formatted timestamp.

Format: date-time

nullablestring

An ISO8601 formatted timestamp.

Format: date-time

nullablestring

The ID for the Identity Verification preceding this session. This field will only be filled if the current Identity Verification is a retry of a previous attempt.

nullablestring

A shareable URL that can be sent directly to the user to complete verification

object

The resource ID and version number of the template configuring the behavior of a given identity verification.

id

string

ID of the associated Identity Verification template.

integer

Version of the associated Identity Verification template.

user

object

The identity data that was either collected from the user or provided via API in order to perform an identity verification.

nullablestring

A phone number in E.164 format.

nullablestring

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

Format: date

nullablestring

An IPv4 or IPV6 address.

nullablestring

A valid email address.

Format: email

name

nullableobject

The full name provided by the user. If the user has not submitted their name, this field will be null. Otherwise, both fields are guaranteed to be filled.

string

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

string

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

nullableobject

nullablestring

The primary street portion of an address. If the user has submitted their address, this field will always be filled.

nullablestring

Extra street information, like an apartment or suite number.

city

nullablestring

City from the end user's address

nullablestring

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

nullablestring

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

string

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

Min length: 2

nullableobject

string

Value of identity document value typed in by user. Alpha-numeric, with all formatting characters stripped.

type

string

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.

string

Possible values: active, success, failed, expired, canceled, pending_review

object

string

The status of a step in the identity verification process.

Possible values: success, active, failed, waiting_for_prerequisite, not_applicable, skipped, expired, canceled, pending_review, manually_approved, manually_rejected

string

The status of a step in the identity verification process.

Possible values: success, active, failed, waiting_for_prerequisite, not_applicable, skipped, expired, canceled, pending_review, manually_approved, manually_rejected

string

The status of a step in the identity verification process.

Possible values: success, active, failed, waiting_for_prerequisite, not_applicable, skipped, expired, canceled, pending_review, manually_approved, manually_rejected

string

The status of a step in the identity verification process.

Possible values: success, active, failed, waiting_for_prerequisite, not_applicable, skipped, expired, canceled, pending_review, manually_approved, manually_rejected

string

The status of a step in the identity verification process.

Possible values: success, active, failed, waiting_for_prerequisite, not_applicable, skipped, expired, canceled, pending_review, manually_approved, manually_rejected

string

The status of a step in the identity verification process.

Possible values: success, active, failed, waiting_for_prerequisite, not_applicable, skipped, expired, canceled, pending_review, manually_approved, manually_rejected

string

The status of a step in the identity verification process.

Possible values: success, active, failed, waiting_for_prerequisite, not_applicable, skipped, expired, canceled, pending_review, manually_approved, manually_rejected

nullableobject

string

The outcome status for the associated Identity Verification attempt's documentary_verification step. This field will always have the same value as steps.documentary_verification.

documents

[object]

string

An outcome status for this specific document submission. Distinct from the overall documentary_verification.status that summarizes the verification outcome from one or more documents.

Possible values: success, failed, manually_approved

integer

The attempt field begins with 1 and increments with each subsequent document upload.

images

object

original_front

nullablestring

Temporary URL that expires after 60 seconds for downloading the uncropped original image of the front of the document.

original_back

nullablestring

Temporary URL that expires after 60 seconds for downloading the original image of the back of the document. Might be null if the back of the document was not collected.

cropped_front

nullablestring

Temporary URL that expires after 60 seconds for downloading a cropped image containing just the front of the document.

cropped_back

nullablestring

Temporary URL that expires after 60 seconds for downloading a cropped image containing just the back of the document. Might be null if the back of the document was not collected.

face

nullablestring

Temporary URL that expires after 60 seconds for downloading a crop of just the user's face from the document image. Might be null if the document does not contain a face photo.

nullableobject

Data extracted from a user-submitted document.

nullablestring

Alpha-numeric ID number extracted via OCR from the user's document image.

category

string

Possible values: drivers_license, id_card, passport, residence_permit_card, resident_card, visa

nullablestring

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

Format: date

string

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

Min length: 2

issuing_region

nullablestring

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

nullablestring

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

Format: date

nullableobject

string

The full street address extracted from the document.

city

string

City extracted from the document.

nullablestring

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

nullablestring

The postal code extracted from the document. Between 2 and 10 alphanumeric characters. For US-based addresses this must be 5 numeric digits.

string

Valid, capitalized, two-letter ISO code representing the country extracted from the document. Must be in ISO 3166-1 alpha-2 form.

Min length: 2

object

High level descriptions of how the associated document was processed. If a document fails verification, the details in the analysis object should help clarify why the document was rejected.

authenticity

string

Possible values: match, partial_match, no_match, no_data

image_quality

string

Possible values: high, medium, low

nullableobject

Analysis of the data extracted from the submitted document.

name

string

A match summary describing the cross comparison between the subject's name, extracted from the document image, and the name they separately provided to identity verification attempt.

Possible values: match, partial_match, no_match

string

Possible values: match, partial_match, no_match

string

Possible values: not_expired, expired, no_data

string

Possible values: match, no_match

nullablestring

An ISO8601 formatted timestamp.

Format: date-time

nullableobject

Additional information for the selfie_check step. This field will be null unless steps.selfie_check has reached a terminal state of either success or failed.

string

The outcome status for the associated Identity Verification attempt's selfie_check step. This field will always have the same value as steps.selfie_check.

Possible values: success, failed

selfies

[object]

An array of selfies submitted to the selfie_check step. Each entry represents one user submission.

string

An outcome status for this specific selfie. Distinct from the overall selfie_check.status that summarizes the verification outcome from one or more selfies.

Possible values: success, failed

integer

The attempt field begins with 1 and increments with each subsequent selfie upload.

capture

object

The image or video capture of a selfie. Only one of image or video URL will be populated per selfie.

image_url

nullablestring

Temporary URL for downloading an image selfie capture.

video_url

nullablestring

Temporary URL for downloading a video selfie capture.

object

High level descriptions of how the associated selfie was processed. If a selfie fails verification, the details in the analysis object should help clarify why the selfie was rejected.

document_comparison

string

Information about the comparison between the selfie and the document (if documentary verification also ran).

Possible values: match, no_match, no_input

nullableobject

Additional information for the kyc_check step. This field will be null unless steps.kyc_check has reached a terminal state of either success or failed.

string

The outcome status for the associated Identity Verification attempt's kyc_check step. This field will always have the same value as steps.kyc_check.

object

Result summary object specifying how the address field matched.

string

Possible values: match, partial_match, no_match, no_data, no_input

po_box

string

Possible values: yes, no, no_data

type

string

Possible values: residential, commercial, no_data

name

object

Result summary object specifying how the name field matched.

string

Possible values: match, partial_match, no_match, no_data, no_input

object

Result summary object specifying how the date_of_birth field matched.

string

Possible values: match, partial_match, no_match, no_data, no_input

object

Result summary object specifying how the id_number field matched.

string

Possible values: match, partial_match, no_match, no_data, no_input

object

Result summary object specifying how the phone field matched.

string

Possible values: match, partial_match, no_match, no_data, no_input

area_code

string

Possible values: match, partial_match, no_match, no_data, no_input

nullableobject

Additional information for the risk_check step.

domain_is_free_provider

string

The status of a step in the identity verification process.

Possible values: success, active, failed, waiting_for_prerequisite, not_applicable, skipped, expired, canceled, pending_review, manually_approved, manually_rejected

behavior

nullableobject

Result summary object specifying values for behavior attributes of risk check, when available.

user_interactions

string

Possible values: genuine, neutral, risky, no_data

fraud_ring_detected

string

Possible values: yes, no, no_data

bot_detected

string

Possible values: yes, no, no_data

email

nullableobject

Result summary object specifying values for email attributes of risk check.

is_deliverable

string

SMTP-MX check to confirm the email address exists if known.

Possible values: yes, no, no_data

breach_count

nullableinteger

Count of all known breaches of this email address if known.

first_breached_at

nullablestring

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

Format: date

last_breached_at

nullablestring

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

Format: date

domain_registered_at

nullablestring

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

Format: date

string

Indicates whether the email address domain is a free provider such as Gmail or Hotmail if known.

Possible values: yes, no, no_data

domain_is_custom

string

Indicates whether the email address domain is custom if known, i.e. a company domain and not free or disposable.

Possible values: yes, no, no_data

domain_is_disposable

string

Indicates whether the email domain is listed as disposable if known. Disposable domains are often used to create email addresses that are part of a fake set of user details.

Possible values: yes, no, no_data

top_level_domain_is_suspicious

string

Possible values: yes, no, no_data

[string]

A list of online services where this email address has been detected to have accounts or other activity.

phone

nullableobject

Result summary object specifying values for phone attributes of risk check.

[string]

A list of online services where this phone number has been detected to have accounts or other activity.

devices

[object]

Array of result summary objects specifying values for device attributes of risk check.

ip_proxy_type

nullablestring

Possible values: none_detected, tor, vpn, web_proxy, public_proxy

ip_spam_list_count

nullableinteger

Count of spam lists the IP address is associated with if known.

ip_timezone_offset

nullablestring

UTC offset of the timezone associated with the IP address.

identity_abuse_signals

nullableobject

Result summary object capturing abuse signals related to identity abuse, e.g. stolen and synthetic identity fraud.

synthetic_identity

nullableobject

integer

A score from 0 to 100 indicating the likelihood that the user is a synthetic identity.

stolen_identity

nullableobject

integer

A score from 0 to 100 indicating the likelihood that the user is a stolen identity.

watchlist_screening_id

nullablestring

ID of the associated screening.

nullablestring

An ISO8601 formatted timestamp.

Format: date-time

next_cursor

nullablestring

An identifier that determines which page of results you receive.

request_id

string

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

API Object
1{
"identity_verifications": [
  {
    "id": "idv_52xR9LKo77r1Np",
    "client_user_id": "your-db-id-3b24110",
    "created_at": "2020-07-24T03:26:02Z",
    "completed_at": "2020-07-24T03:26:02Z",
    "previous_attempt_id": "idv_42cF1MNo42r9Xj",
    "shareable_url": "https://flow.plaid.com/verify/idv_4FrXJvfQU3zGUR?key=e004115db797f7cc3083bff3167cba30644ef630fb46f5b086cde6cc3b86a36f",
    "template": {
      "id": "idvtmp_4FrXJvfQU3zGUR",
      "version": 2
    },
    "user": {
      "phone_number": "+19876543212",
      "date_of_birth": "1990-05-29",
      "ip_address": "192.0.2.42",
      "email_address": "user@example.com",
      "name": {
        "given_name": "Leslie",
        "family_name": "Knope"
      },
      "address": {
        "street": "123 Main St.",
        "street2": "Unit 42",
        "city": "Pawnee",
        "region": "IN",
        "postal_code": "46001",
        "country": "US"
      },
      "id_number": {
        "value": "123456789",
        "type": "us_ssn"
      }
    },
    "status": "success",
    "steps": {
      "accept_tos": "success",
      "verify_sms": "success",
      "kyc_check": "success",
      "documentary_verification": "success",
      "selfie_check": "success",
      "watchlist_screening": "success",
      "risk_check": "success"
    },
    "documentary_verification": {
      "status": "success",
      "documents": [
        {
          "status": "success",
          "attempt": 1,
          "images": {
            "original_front": "https://example.plaid.com/verifications/idv_52xR9LKo77r1Np/documents/1/original_front.jpeg",
            "original_back": "https://example.plaid.com/verifications/idv_52xR9LKo77r1Np/documents/1/original_back.jpeg",
            "cropped_front": "https://example.plaid.com/verifications/idv_52xR9LKo77r1Np/documents/1/cropped_front.jpeg",
            "cropped_back": "https://example.plaid.com/verifications/idv_52xR9LKo77r1Np/documents/1/cropped_back.jpeg",
            "face": "https://example.plaid.com/verifications/idv_52xR9LKo77r1Np/documents/1/face.jpeg"
          },
          "extracted_data": {
            "id_number": "AB123456",
            "category": "drivers_license",
            "expiration_date": "1990-05-29",
            "issuing_country": "US",
            "issuing_region": "IN",
            "date_of_birth": "1990-05-29",
            "address": {
              "street": "123 Main St. Unit 42",
              "city": "Pawnee",
              "region": "IN",
              "postal_code": "46001",
              "country": "US"
            }
          },
          "analysis": {
            "authenticity": "match",
            "image_quality": "high",
            "extracted_data": {
              "name": "match",
              "date_of_birth": "match",
              "expiration_date": "not_expired",
              "issuing_country": "match"
            }
          },
          "redacted_at": "2020-07-24T03:26:02Z"
        }
      ]
    },
    "selfie_check": {
      "status": "success",
      "selfies": [
        {
          "status": "success",
          "attempt": 1,
          "capture": {
            "image_url": "https://example.plaid.com/verifications/idv_52xR9LKo77r1Np/selfie/liveness.jpeg",
            "video_url": "https://example.plaid.com/verifications/idv_52xR9LKo77r1Np/selfie/liveness.webm"
          },
          "analysis": {
            "document_comparison": "match"
          }
        }
      ]
    },
    "kyc_check": {
      "status": "success",
      "address": {
        "summary": "match",
        "po_box": "yes",
        "type": "residential"
      },
      "name": {
        "summary": "match"
      },
      "date_of_birth": {
        "summary": "match"
      },
      "id_number": {
        "summary": "match"
      },
      "phone_number": {
        "summary": "match",
        "area_code": "match"
      }
    },
    "risk_check": {
      "status": "success",
      "behavior": {
        "user_interactions": "risky",
        "fraud_ring_detected": "yes",
        "bot_detected": "yes"
      },
      "email": {
        "is_deliverable": "yes",
        "breach_count": 1,
        "first_breached_at": "1990-05-29",
        "last_breached_at": "1990-05-29",
        "domain_registered_at": "1990-05-29",
        "domain_is_free_provider": "yes",
        "domain_is_custom": "yes",
        "domain_is_disposable": "yes",
        "top_level_domain_is_suspicious": "yes",
        "linked_services": [
          "apple"
        ]
      },
      "phone": {
        "linked_services": [
          "apple"
        ]
      },
      "devices": [
        {
          "ip_proxy_type": "none_detected",
          "ip_spam_list_count": 1,
          "ip_timezone_offset": "+06:00:00"
        }
      ],
      "identity_abuse_signals": {
        "synthetic_identity": {
          "score": 0
        },
        "stolen_identity": {
          "score": 0
        }
      }
    },
    "watchlist_screening_id": "scr_52xR9LKo77r1Np",
    "redacted_at": "2020-07-24T03:26:02Z"
  }
],
"next_cursor": "eyJkaXJlY3Rpb24iOiJuZXh0Iiwib2Zmc2V0IjoiMTU5NDM",
"request_id": "saKrIBuEB9qJZng"
173}

Was this helpful?

`/identity_verification/retry`

Retry an Identity Verification

Allow a customer to retry their identity verification

identity_verification/retry

Request fields and example

requiredstring

Min length: 1

template_id

requiredstring

ID of the associated Identity Verification template.

strategy

requiredstring

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

user

object

string

A valid email address.

Format: email

string

A phone number in E.164 format.

string

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

Format: date

name

object

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.

requiredstring

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

requiredstring

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

object

Home address for the user. For more context on this field, see Input Validation by Country.

requiredstring

The primary street portion of an address. If the user has submitted their address, this field will always be filled.

string

Extra street information, like an apartment or suite number.

city

requiredstring

City from the end user's address

string

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

string

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

requiredstring

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

Min length: 2

object

requiredstring

Value of identity document value typed in by user. Alpha-numeric, with all formatting characters stripped.

type

requiredstring

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.

object

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.

requiredboolean

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

requiredboolean

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

requiredboolean

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

requiredboolean

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

string

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.

string

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.

/identity_verification/retry
Select Language
1const request: IdentityVerificationRetryRequest = {
client_user_id: 'user-sandbox-b0e2c4ee-a763-4df5-bfe9-46a46bce993d',
template_id: 'idv_52xR9LKo77r1Np',
strategy: 'reset',
user: {
  email_address: 'acharleston@email.com',
  phone_number: '+11234567890',
  date_of_birth: '1975-01-18',
  name: {
    given_name: 'Anna',
    family_name: 'Charleston',
  },
  address: {
    street: '100 Market Street',
    street2: 'Apt 1A',
    city: 'San Francisco',
    region: 'CA',
    postal_code: '94103',
    country: 'US',
  },
  id_number: {
    value: '123456789',
    type: 'us_ssn',
  },
},
26};
27try {
const response = await plaidClient.identityVerificationRetry(request);
29} catch (error) {
// handle error
31}

identity_verification/retry

Response fields and example

id

string

ID of the associated Identity Verification attempt.

string

Min length: 1

string

An ISO8601 formatted timestamp.

Format: date-time

nullablestring

An ISO8601 formatted timestamp.

Format: date-time

nullablestring

The ID for the Identity Verification preceding this session. This field will only be filled if the current Identity Verification is a retry of a previous attempt.

nullablestring

A shareable URL that can be sent directly to the user to complete verification

object

The resource ID and version number of the template configuring the behavior of a given identity verification.

id

string

ID of the associated Identity Verification template.

integer

Version of the associated Identity Verification template.

user

object

The identity data that was either collected from the user or provided via API in order to perform an identity verification.

nullablestring

A phone number in E.164 format.

nullablestring

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

Format: date

nullablestring

An IPv4 or IPV6 address.

nullablestring

A valid email address.

Format: email

name

nullableobject

The full name provided by the user. If the user has not submitted their name, this field will be null. Otherwise, both fields are guaranteed to be filled.

string

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

string

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

nullableobject

nullablestring

The primary street portion of an address. If the user has submitted their address, this field will always be filled.

nullablestring

Extra street information, like an apartment or suite number.

city

nullablestring

City from the end user's address

nullablestring

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

nullablestring

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

string

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

Min length: 2

nullableobject

string

Value of identity document value typed in by user. Alpha-numeric, with all formatting characters stripped.

type

string

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.

string

Possible values: active, success, failed, expired, canceled, pending_review

object

string

The status of a step in the identity verification process.

Possible values: success, active, failed, waiting_for_prerequisite, not_applicable, skipped, expired, canceled, pending_review, manually_approved, manually_rejected

string

The status of a step in the identity verification process.

Possible values: success, active, failed, waiting_for_prerequisite, not_applicable, skipped, expired, canceled, pending_review, manually_approved, manually_rejected

string

The status of a step in the identity verification process.

Possible values: success, active, failed, waiting_for_prerequisite, not_applicable, skipped, expired, canceled, pending_review, manually_approved, manually_rejected

string

The status of a step in the identity verification process.

Possible values: success, active, failed, waiting_for_prerequisite, not_applicable, skipped, expired, canceled, pending_review, manually_approved, manually_rejected

string

The status of a step in the identity verification process.

Possible values: success, active, failed, waiting_for_prerequisite, not_applicable, skipped, expired, canceled, pending_review, manually_approved, manually_rejected