plaid

Retrieve network attributes for the user

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

post/cra/check_report/network_insights/get

Request body

client_idstring

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.

secretstring

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_idstring

A unique user identifier, created by /user/create. Integrations that began using /user/create after December 10, 2025 use this field to identify a user instead of the user_token. For more details, see New User APIs.

third_party_user_tokenstring

The third-party user token associated with the requested User data.

user_tokenstring

The user token associated with the user for which data is being requested. This field is used only by customers with pre-existing integrations that already use the user_token field. All other customers should use the user_id instead. For more details, see New User APIs.

Response

OK

request_idstring required

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

Changes

Changed in 15 of the 53 revisions of this API.34619

    • the security scope cra:read was added to the endpoint's security scheme oauth2

      api-security-scope-added

    • the security scope cra:report:read was removed from the endpoint's security scheme oauth2

      api-security-scope-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • a1bbca018160263See the full diff
    • added the new ASSETS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new ASSETS_ERROR enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new CRA_MONITORING_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new CRA_MONITORING_ERROR enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new CREDIT_PROFILE_REPORT_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new CREDIT_PROFILE_REPORT_ERROR enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new ENCOMPASS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new ENCOMPASS_ERROR enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new ENRICH_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new ENRICH_ERROR enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new FRAUD_INSIGHTS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new FRAUD_INSIGHTS_ERROR enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new FREDDIE_MAC_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new FREDDIE_MAC_ERROR enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new LINK_DELIVERY_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new LINK_DELIVERY_ERROR enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new PROFILE_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new PROFILE_ERROR enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new RECURRING_TRANSACTIONS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new RECURRING_TRANSACTIONS_ERROR enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new STATEMENTS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new STATEMENTS_ERROR enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new TRANSFER_RECURRING_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new TRANSFER_RECURRING_ERROR enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new TRANSFER_REFUND_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new TRANSFER_REFUND_ERROR enum value to the //// response property for the response status

      response-property-enum-value-added

    • the endpoint scheme security clientId AND secret AND plaidVersion was added to the API

      api-security-added

    • the endpoint scheme security oauth2 was added to the API

      api-security-added

    • request property deprecated

      request-property-deprecated

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new IDEMPOTENCY_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new IDEMPOTENCY_ERROR enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new BASE_REPORT_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new BASE_REPORT_ERROR enum value to the //// response property for the response status

      response-property-enum-value-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 465584b48c99114See the full diff
    • the request property type changed from no type to string

      request-property-type-changed

    • removed from the request property allOf list

      request-property-all-of-removed

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property //// to the response with the status

      response-optional-property-added

    • added the optional property //// to the response with the status

      response-optional-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 4abee1c5692912See the full diff
    • removed subschema #2 from the request property allOf list

      request-property-all-of-removed

    • removed the IDENTITY_ERROR enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the IDENTITY_ERROR enum value from the //// response property for the response status

      response-property-enum-value-removed

    • added the new IDENTITY_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new IDENTITY_ERROR enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new USER_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new USER_ERROR enum value to the //// response property for the response status

      response-property-enum-value-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • af4b6e71d87f21See the full diff
    • added the new SIGNAL_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new SIGNAL_ERROR enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new optional request property

      new-optional-request-property

    • added subschema #2 to the request property allOf list

      request-property-all-of-added

    • removed subschema #2 subschema #3 from the request property allOf list

      request-property-all-of-removed

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new optional request property

      new-optional-request-property