Sign in
plaid

Get FDX consent grant

Returns a consent grant by its identifier.

get/fdx/consents/{consentId}

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

Changed in 5 of the 53 revisions of this API.22240

  • e536704a333f1838See the full diff
    • ▲

      removed the required property display_message from the response with the default status

      response-required-property-removed

    • ●

      removed the optional property causes from the response with the default status

      response-optional-property-removed

    • ●

      removed the optional property documentation_url from the response with the default status

      response-optional-property-removed

    • ●

      removed the optional property error_code_reason from the response with the default status

      response-optional-property-removed

    • ●

      removed the optional property provided_account_subtypes from the response with the default status

      response-optional-property-removed

    • ●

      removed the optional property request_id from the response with the default status

      response-optional-property-removed

    • ●

      removed the optional property required_account_subtypes from the response with the default status

      response-optional-property-removed

    • ●

      removed the optional property status from the response with the default status

      response-optional-property-removed

    • ●

      removed the optional property suggested_action from the response with the default status

      response-optional-property-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

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

  • a1bbca01816013See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

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

  • 80d23bfdc2e511See the full diff
    • ●

      added the new IDEMPOTENCY_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • ○

      api operation id fdxConsentGet removed and replaced with fdxConsentsGet

      api-operation-id-removed

  • fb8c3f188d8b1See the full diff
    • ○

      endpoint added

      endpoint-added

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

  • 5de70cc1e6ca1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

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