Retrieve various verification reports for a user.

POST /cra/check_report/verification/get

This endpoint allows you to retrieve verification reports for a user. To obtain a VoA or Employment Refresh report, you need to make sure that cra_base_report is included in the products parameter when calling /link/token/create or /cra/check_report/create.

You should call this endpoint after you've received a CHECK_REPORT_READY webhook, either after the Link session for the user or after calling /cra/check_report/create.

If the most recent consumer report for the user doesn’t have sufficient data to generate the report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling /cra/check_report/create."

Request Body

Required

CraCheckReportVerificationGetRequest defines the request schema for /cra/check_report/verification/get.

Parameters

client_id
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.
secret
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.
reports_requested
required, array[string]
Specifies which types of verification reports are expected in the response
employment_refresh_options
object
Defines configuration options for the Employment Refresh Report.
days_requested
required, integer
The number of days of data to request for the report. This field is required if an Employment Refresh Report is requested. Maximum is 731.
user_token
string
The user token associated with the User data is being requested for.
user_id
object

Response

CraCheckReportVerificationGetResponse defines the response schema for /cra/check_report/verification/get.

Response Properties

report
required, object
Contains data for the CRA Verification Report.
report_id
required, string
The unique identifier associated with the Verification Report object. This ID will be the same as the Base Report ID.
client_report_id
string
Client-generated identifier, which can be used by lenders to track loan applications.
voa
object
An object representing a VOA report.
generated_time
required, string
The date and time when the VOA Report was created, in ISO 8601 format (e.g. “2018-04-12T03:32:11Z”).
days_requested
required, number
The number of days of transaction history that the VOA report covers.
items
required, array[object]
Data returned by Plaid about each of the Items included in the Base Report.
accounts
required, array[object]
Data about each of the accounts open on the Item.
account_id
required, string
Plaid’s unique identifier for the account. This value will not change unless Plaid can’t reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new account_id will be assigned to the account. If an account with a specific account_id disappears instead of changing, the account is likely closed. Closed accounts are not returned by the Plaid API. Like all Plaid identifiers, the account_id is case sensitive.
balances
required, object
VOA Report information about an account’s balances.
consumer_disputes
required, array[object]
The information about previously submitted valid dispute statements by the consumer
mask
required, string
The last 2-4 alphanumeric characters of an account’s official account number. Note that the mask may be non-unique between an Item’s accounts, and it may also not match the mask that the bank displays to the user.
name
required, string
The name of the account, either assigned by the user or by the financial institution itself.
official_name
required, string
The official name of the account as given by the financial institution.
type
required, string
investment: Investment account. In API versions 2018-05-22 and earlier, this type is called brokerage instead. credit: Credit card depository: Depository account loan: Loan account other: Non-specified account type See the Account type schema for a full listing of account types and corresponding subtypes.
subtype
required, string
See the Account type schema for a full listing of account types and corresponding subtypes.
days_available
required, number
The duration of transaction history available within this report for this Item, typically defined as the time since the date of the earliest transaction in that account.
transactions_insights
required, object
Transaction data associated with the account.
owners
required, array[object]
Data returned by the financial institution about the account owner or owners.
ownership_type
required, string
How an asset is owned. association: Ownership by a corporation, partnership, or unincorporated association, including for-profit and not-for-profit organizations. individual: Ownership by an individual. joint: Joint ownership by multiple parties. trust: Ownership by a revocable or irrevocable trust.
institution_name
required, string
The full financial institution name associated with the Item.
institution_id
required, string
The id of the financial institution associated with the Item.
item_id
required, string
The item_id of the Item associated with this webhook, warning, or error
last_update_time
required, string
The date and time when this Item’s data was last retrieved from the financial institution, in ISO 8601 format.
attributes
required, object
Attributes for the VOA report.
total_inflow_amount
required, object
Total amount of debit transactions into the report’s accounts in the time period of the report. This field only takes into account USD transactions from the accounts.
amount
required, number
Value of amount with up to 2 decimal places.
iso_currency_code
required, string
The ISO 4217 currency code of the amount or balance.
unofficial_currency_code
required, string
The unofficial currency code associated with the amount or balance. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
total_outflow_amount
required, object
Total amount of credit transactions into the report’s accounts in the time period of the report. This field only takes into account USD transactions from the accounts.
amount
required, number
Value of amount with up to 2 decimal places.
iso_currency_code
required, string
The ISO 4217 currency code of the amount or balance.
unofficial_currency_code
required, string
The unofficial currency code associated with the amount or balance. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
employment_refresh
object
An object representing an Employment Refresh Report.
generated_time
required, string
The date and time when the Employment Refresh Report was created, in ISO 8601 format (e.g. “2018-04-12T03:32:11Z”).
days_requested
required, number
The number of days of transaction history that the Employment Refresh Report covers.
items
required, array[object]
Data returned by Plaid about each of the Items included in the Employment Refresh Report.
accounts
required, array[object]
Data about each of the accounts open on the Item.
account_id
required, string
Plaid’s unique identifier for the account. This value will not change unless Plaid can’t reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new account_id will be assigned to the account. If an account with a specific account_id disappears instead of changing, the account is likely closed. Closed accounts are not returned by the Plaid API. Like all Plaid identifiers, the account_id is case sensitive.
name
required, string
The name of the account, either assigned by the user or by the financial institution itself.
official_name
required, string
The official name of the account as given by the financial institution.
type
required, string
investment: Investment account. In API versions 2018-05-22 and earlier, this type is called brokerage instead. credit: Credit card depository: Depository account loan: Loan account other: Non-specified account type See the Account type schema for a full listing of account types and corresponding subtypes.
subtype
required, string
See the Account type schema for a full listing of account types and corresponding subtypes.
transactions
required, array[object]
Transaction history associated with the account for the Employment Refresh Report. Note that this transaction differs from a Base Report transaction in that it will only be deposits, and the amounts will be omitted.
institution_name
required, string
The full financial institution name associated with the Item.
institution_id
required, string
The id of the financial institution associated with the Item.
item_id
required, string
The item_id of the Item associated with this webhook, warning, or error
last_update_time
required, string
The date and time when this Item’s data was last retrieved from the financial institution, in ISO 8601 format.
request_id
required, string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
warnings
required, array[object]
If the verification report generation was successful but a subset of data could not be retrieved, this array will contain information about the errors causing information to be missing.
warning_type
required, string
The warning type, which will always be CHECK_REPORT_WARNING
warning_code
required, string
The warning code identifies a specific kind of warning. IDENTITY_UNAVAILABLE: Account-owner information is not available. TRANSACTIONS_UNAVAILABLE: Transactions information associated with Credit and Depository accounts are unavailable. USER_FRAUD_ALERT: The user has placed a fraud alert on their Plaid Check consumer report due to suspected fraud. Please note that when a fraud alert is in place, the recipient of the consumer report has an obligation to verify the consumer’s identity.
cause
required, object
An error object and associated item_id used to identify a specific Item and error when a batch operation operating on multiple Items has encountered an error in one of the Items.