Sign in
latestSwagger 2.02026-08-20196638916.1 KB

23d8982b533d

Connectivity v2.Consent
BETA

Revoke a consent

post/connectivity/v2/consents/{consentId}:revoke

Path parameters

consentIdstring required

The consent id.

Headers

Idempotency-Keystring required

An idempotency key is any unique key generated by the client which the resource server uses to recognize subsequent retries of the same request. The Idempotency-Key HTTP request header field carries this key.

Response

Revocation successfully started.

authorizationConnectivity20v2Authorization — unresolved $ref
consentConnectivity20v2Consent — unresolved $ref

Example response

{
  "authorization": {
    "consentId": "c63dc11e-b210-4a96-9461-2061389789e7",
    "createdAt": "2022-12-26T21:33:12.000Z",
    "id": "a0655566-bec8-4982-bf79-80f6a6dd2b47",
    "state": "REVOKING",
    "succeededAt": "2022-12-26T21:35:11.000Z"
  },
  "consent": {
    "appId": "afae2e2a57b64009aa94f593d012b869",
    "authorizedAt": "2022-12-26T21:35:11.000Z",
    "createdAt": "2022-12-26T21:32:12.000Z",
    "financialService": {
      "subtype": "VRP_SWEEPING",
      "type": "MANDATE_PAYMENTS"
    },
    "financialServiceParameters": {
      "userParameters": {
        "parameter": "value"
      },
      "version": "1.0.0"
    },
    "id": "c63dc11e-b210-4a96-9461-2061389789e7",
    "providerId": "uk-natwest-oauth2",
    "revokedAt": "2022-12-26T21:32:12.000Z",
    "state": "REVOKED",
    "userId": "7c41103806a011edb9390242ac120002"
  }
}