plaid

Update an Audit Copy Token

Changed on

The /credit/audit_copy_token/update endpoint updates an existing Audit Copy Token by adding the report tokens in the report_tokens field to the audit_copy_token. If the Audit Copy Token already contains a report of a certain type, it will be replaced with the token provided in the report_tokens field.

post/credit/audit_copy_token/update

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/credit/audit_copy_token/update
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

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.

audit_copy_tokenstring required

The audit_copy_token you would like to update.

report_tokensAssetReportToken[] required

Array of tokens which the specified Audit Copy Token will be updated with. The types of token supported are asset report token and employment report token. There can be at most 1 of each token type in the array.

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.

updatedboolean required

true if the Audit Copy Token was successfully updated.

Changes

    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the response property for the response status

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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