ID of the associated Identity Verification attempt.

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.

An ISO8601 formatted timestamp.

An ISO8601 formatted timestamp.

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.

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

The resource ID and version number of the template configuring the behavior of a given Identity Verification.

ID of the associated Identity Verification template. Like all Plaid identifiers, this is case-sensitive.

Version of the associated Identity Verification template.

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

A valid phone number in E.164 format.

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

An IPv4 or IPV6 address.

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

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.

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.

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

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.

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.

City from the end user’s address. A string with at least one non-whitespace alphabetical character, with a max length of 100 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.

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.

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.

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.

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.

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.

The status of a step in the Identity Verification process.

The status of a step in the Identity Verification process.

The status of a step in the Identity Verification process.

The status of a step in the Identity Verification process.

The status of a step in the Identity Verification process.

The status of a step in the Identity Verification process.

The status of a step in the Identity Verification process.

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.

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.

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.

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.

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

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.

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

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.

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

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.

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.

Data extracted from a user-submitted document.

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

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

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

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

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

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

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.

The full street address extracted from the document.

City extracted from the document.

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

The postal code extracted from the document. 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 extracted from the document. Must be in ISO 3166-1 alpha-2 form.

The individual’s name extracted from the document.

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.

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.

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.

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.

Analysis of the data extracted from the submitted document.

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.

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.

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.

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.

Details about the fraud analysis performed on the document.

The outcome of the fraud check.

The outcome of the fraud check.

The outcome of the fraud check.

The outcome of the fraud check.

The outcome of the fraud check.

The outcome of the fraud check.

The outcome of the fraud check, when available.

Details about the image quality of the document.

The outcome of the image quality check.

The outcome of the image quality check.

The outcome of the image quality check.

Details about the human review check, which refers to a check that is performed by a document specialist.

The outcome of the human review check, when available. The following values are possible: success - The document passed the check. failed - The document failed the check. no_data - The document was submitted, but the document specialist review was not completed in time.

Analyzed AAMVA data for the associated hit. Note: This field is only available for U.S. driver’s licenses issued by participating states.

The overall outcome of checking the associated hit against the issuing state database.

The outcome of checking the particular field against state databases. match - The field is an exact match with the state database. no_match - The field is not an exact match with the state database. no_data - The field was unable to be checked against state databases.

The outcome of checking the particular field against state databases. match - The field is an exact match with the state database. no_match - The field is not an exact match with the state database. no_data - The field was unable to be checked against state databases.

The outcome of checking the particular field against state databases. match - The field is an exact match with the state database. no_match - The field is not an exact match with the state database. no_data - The field was unable to be checked against state databases.

The outcome of checking the associated hit against state databases. match - The field is an exact match with the state database. partial_match - The field is a partial match with the state database. no_match - The field is not an exact match with the state database. no_data - The field was unable to be checked against state databases.

The outcome of checking the particular field against state databases. match - The field is an exact match with the state database. no_match - The field is not an exact match with the state database. no_data - The field was unable to be checked against state databases.

The outcome of checking the associated hit against state databases. match - The field is an exact match with the state database. partial_match - The field is a partial match with the state database. no_match - The field is not an exact match with the state database. no_data - The field was unable to be checked against state databases.

The outcome of checking the particular field against state databases. match - The field is an exact match with the state database. no_match - The field is not an exact match with the state database. no_data - The field was unable to be checked against state databases.

The outcome of checking the particular field against state databases. match - The field is an exact match with the state database. no_match - The field is not an exact match with the state database. no_data - The field was unable to be checked against state databases.

The outcome of checking the particular field against state databases. match - The field is an exact match with the state database. no_match - The field is not an exact match with the state database. no_data - The field was unable to be checked against state databases.

The outcome of checking the particular field against state databases. match - The field is an exact match with the state database. no_match - The field is not an exact match with the state database. no_data - The field was unable to be checked against state databases.

The outcome of checking the associated hit against state databases. match - The field is an exact match with the state database. partial_match - The field is a partial match with the state database. no_match - The field is not an exact match with the state database. no_data - The field was unable to be checked against state databases.

The outcome of checking the associated hit against state databases. match - The field is an exact match with the state database. partial_match - The field is a partial match with the state database. no_match - The field is not an exact match with the state database. no_data - The field was unable to be checked against state databases.

The outcome of checking the associated hit against state databases. match - The field is an exact match with the state database. partial_match - The field is a partial match with the state database. no_match - The field is not an exact match with the state database. no_data - The field was unable to be checked against state databases.

An ISO8601 formatted timestamp.

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.

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.

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

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

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

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

Temporary URL for downloading an image selfie capture.

Temporary URL for downloading a video selfie capture.

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.

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

Assessment of whether the selfie capture is of a real human being, as opposed to a picture of a human on a screen, a picture of a paper cut out, someone wearing a mask, or a deepfake.

Analysis of the facial features of the selfie when compared to the face in the uploaded document, if one is present.

Outcome of the facial analysis for a specific facial feature.

Outcome of the facial analysis for a specific facial feature.

Outcome of the facial analysis for a specific facial feature.

Outcome of the facial analysis for a specific facial feature.

Outcome of the facial analysis for a specific facial feature.

Outcome of the facial analysis for a specific facial feature.

Outcome of the facial analysis for a specific facial feature.

Outcome of the facial analysis for a specific facial feature.

Outcome of the facial analysis for a specific facial feature.

Outcome of the facial analysis for a specific facial feature.

Outcome of the facial analysis for a specific facial feature.

Outcome of the facial analysis for a specific facial feature.

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

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.

Result summary object specifying how the address field matched.

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.

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.

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.

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.

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.

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.

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.

Result summary object specifying how the address field matched for fields that are only present on an international KYC check.

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.

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.

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.

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.

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.

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.

Result summary object specifying how the name field matched.

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.

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.

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.

Result summary object specifying how the date_of_birth field matched.

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.

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.

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.

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.

Result summary object specifying how the id_number field matched.

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.

Result summary object specifying how the phone field matched.

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.

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.

Additional information for the risk_check step.

The status of a step in the Identity Verification process.

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

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.

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.

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.

Risk level for the given risk check type, when available.

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

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

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

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

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

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

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

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

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.

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.

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

Risk level for the given risk check type.

List of factors, when available, that contribute towards the risk level of the given risk check type.

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

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

Risk level for the given risk check type.

List of factors, when available, that contribute towards the risk level of the given risk check type.

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

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.

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

UTC offset of the timezone associated with the IP address.

Risk level for the given risk check type.

List of factors, when available, that contribute towards the risk level of the given risk check type.

Result summary object capturing abuse signals related to identity abuse, e.g. stolen and synthetic identity fraud. These attributes are only available for US identities and some signals may not be available depending on what information was collected.

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.

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

Risk level for the given risk check type.

Field containing the data used in determining the outcome of a synthetic fraud risk check.

Risk level for the given risk check type.

Field containing the data used in determining the outcome of a synthetic fraud risk check.

Risk level for the given risk check type.

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.

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

Risk level for the given risk check type.

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

Risk level for the given risk check type.

List of factors, when available, that contribute towards the risk level of the given risk check type.

Additional information for the verify_sms step.

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

An array where each entry represents a verification attempt for the verify_sms step. Each entry represents one user-submitted phone number. Phone number edits, and in some cases error handling due to edge cases like rate limiting, may generate additional verifications.

The outcome status for the individual SMS verification.

The attempt field begins with 1 and increments with each subsequent SMS verification.

A phone number in E.164 format.

The number of delivery attempts made within the verification to send the SMS code to the user. Each delivery attempt represents the user taking action from the front end UI to request creation and delivery of a new SMS verification code, or to resend an existing SMS verification code. There is a limit of 3 delivery attempts per verification.

The number of attempts made by the user within the verification to verify the SMS code by entering it into the front end UI. There is a limit of 3 solve attempts per verification.

An ISO8601 formatted timestamp.

An ISO8601 formatted timestamp.

An ISO8601 formatted timestamp.

ID of the associated screening.

ID of the associated Beacon User.

A unique user_id generated by Plaid for the client-provided client_user_id. This field is currently in beta.

An ISO8601 formatted timestamp.

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