Retrieve network attributes for the user

POST /cra/check_report/network_insights/get

This endpoint allows you to retrieve the Network Insights product for your user. You should call this endpoint after you've received the 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.

If you did not initialize Link with the cra_network_attributes product or have generated a report using /cra/check_report/create, we will generate the attributes when you call this endpoint.

Request Body

Required

CraCheckReportNetworkInsightsGetRequest defines the request schema for /cra/check_report/network_attributes/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.
user_token
string
The user token associated with the User data is being requested for.
user_id
object
third_party_user_token
string
The third-party user token associated with the requested User data.

Response

CraCheckReportNetworkInsightsGetResponse defines the response schema for /cra/check_report/network_attributes/get.

Response Properties

report
required, object
Contains data for the CRA Network Attributes Report.
report_id
required, string
The unique identifier associated with the Network Attributes report object.
generated_time
required, string
The time when the Network Attributes Report was generated.
network_attributes
required, object
A map of network attributes, where the key is a string, and the value is a float, int, or boolean.
items
required, array[object]
The Items the end user connected in Link.
institution_id
required, string
The ID for the institution the user linked.
institution_name
required, string
The name of the institution the user linked.
item_id
required, string
The identifier for the Item.
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
array[object]
If the Network Insights 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.