plaid

Get FDX consent grant

Changed on

Returns a consent grant by its identifier.

get/fdx/consents/{consentId}

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/fdx/consents/{consentId}
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

Path parameters

consentIdstring required

Unique identifier of the consent grant.

Response

OK

idstring required

The persistent identifier of the consent grant

status'ACTIVE' | 'REVOKED' | 'EXPIRED' required

Current status of a consent grant. One of ACTIVE, REVOKED, EXPIRED.

createdTimestring date-time required

When the consent was initially granted

updatedTimestring date-time required

When the consent grant was last updated

expirationTimestring date-time

When the consent grant will expire. Omitted when the grant has no expiration.

Changes

  • e536704a333fRevision changes
    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      removed the API_ERROR enum value from the response property for the response status

    • info

      removed the ASSETS_ERROR enum value from the response property for the response status

    • info

      removed the ASSET_REPORT_ERROR enum value from the response property for the response status

    • info

      removed the BANK_TRANSFER_ERROR enum value from the response property for the response status

    • info

      removed the BASE_REPORT_ERROR enum value from the response property for the response status

    • info

      removed the CHECK_REPORT_ERROR enum value from the response property for the response status

    • info

      removed the CONSUMER_REPORT_ERROR enum value from the response property for the response status

    • info

      removed the CRA_MONITORING_ERROR enum value from the response property for the response status

    • info

      removed the CREDIT_PROFILE_REPORT_ERROR enum value from the response property for the response status

    • info

      removed the ENCOMPASS_ERROR enum value from the response property for the response status

    • info

      removed the ENRICH_ERROR enum value from the response property for the response status

    • info

      removed the FRAUD_INSIGHTS_ERROR enum value from the response property for the response status

    • info

      removed the FREDDIE_MAC_ERROR enum value from the response property for the response status

    • info

      removed the IDEMPOTENCY_ERROR enum value from the response property for the response status

    • info

      removed the INCOME_VERIFICATION_ERROR enum value from the response property for the response status

    • info

      removed the INSTITUTION_ERROR enum value from the response property for the response status

    • info

      removed the INVALID_INPUT enum value from the response property for the response status

    • info

      removed the INVALID_REQUEST enum value from the response property for the response status

    • info

      removed the INVALID_RESULT enum value from the response property for the response status

    • info

      removed the ITEM_ERROR enum value from the response property for the response status

    • info

      removed the LINK_DELIVERY_ERROR enum value from the response property for the response status

    • info

      removed the MICRODEPOSITS_ERROR enum value from the response property for the response status

    • info

      removed the OAUTH_ERROR enum value from the response property for the response status

    • info

      removed the PARTNER_ERROR enum value from the response property for the response status

    • info

      removed the PAYMENT_ERROR enum value from the response property for the response status

    • info

      removed the PROFILE_ERROR enum value from the response property for the response status

    • info

      removed the RATE_LIMIT_EXCEEDED enum value from the response property for the response status

    • info

      removed the RECAPTCHA_ERROR enum value from the response property for the response status

    • info

      removed the RECURRING_TRANSACTIONS_ERROR enum value from the response property for the response status

    • info

      removed the SANDBOX_ERROR enum value from the response property for the response status

    • info

      removed the SIGNAL_ERROR enum value from the response property for the response status

    • info

      removed the STATEMENTS_ERROR enum value from the response property for the response status

    • info

      removed the TRANSACTIONS_ERROR enum value from the response property for the response status

    • info

      removed the TRANSACTION_ERROR enum value from the response property for the response status

    • info

      removed the TRANSFER_ERROR enum value from the response property for the response status

    • info

      removed the TRANSFER_RECURRING_ERROR enum value from the response property for the response status

    • info

      removed the TRANSFER_REFUND_ERROR enum value from the response property for the response status

    • info

      removed the USER_ERROR enum value from the response property for the response status

  • a1bbca018160Revision changes
    • 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