{
  "opencollection": "1.0.0",
  "info": {
    "name": "Yapily Beneficiaries Application Beneficiaries Consents API",
    "version": "12.4.0"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Consents",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Exchange Oauth2 Code",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.yapily.com/consent-auth-code",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Used to obtain a Yapily Consent object containing the `consentToken` once the user has authenticated and you have an OAuth2 authorisation code `auth-code` and state `auth-state`."
        },
        {
          "info": {
            "name": "Exchange One Time Token",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.yapily.com/consent-one-time-token",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Exchange a One-time-token for the consent token"
        },
        {
          "info": {
            "name": "Get Consents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.yapily.com/consents",
            "params": [
              {
                "name": "filter[applicationUserId]",
                "value": "",
                "type": "query",
                "description": "__Optional__. Filter records based on the list of `applicationUserId` users provided. At least one of these filters filter[applicationUserId], filter[userUuid]=, limit= must be provided."
              },
              {
                "name": "filter[userUuid]",
                "value": "",
                "type": "query",
                "description": "__Optional__. Filter records based on the list of `userUuid` users provided. At least one of these filters filter[applicationUserId], filter[userUuid]=, limit= must be provided."
              },
              {
                "name": "filter[institution]",
                "value": "",
                "type": "query",
                "description": "__Optional__. Filter records based on the list of `Institution` provided."
              },
              {
                "name": "filter[status]",
                "value": "",
                "type": "query",
                "description": "__Optional__. Filter records based on the list of `Consent` [statuses](/api-reference/getConsents)."
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "__Optional__. Returned transactions will be on or after this date (yyyy-MM-dd'T'HH:mm:ss.SSSZ). "
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "__Optional__. Returned transactions will be on or before this date (yyyy-MM-dd'T'HH:mm:ss.SSSZ)."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "__Optional__. The maximum number of transaction records to be returned. Must be between 1 and 1000. At least one of these filters filter[applicationUserId], filter[userUuid]=, limit= must be provided."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "__Optional__. The number of transaction records to be skipped. Used primarily with paginated results."
              }
            ]
          },
          "docs": "Used to retrieve all the consents created for each user within an application. At least one of the following filters needs to be applied: filter[applicationUserId], filter[userUuid]=, limit=. "
        },
        {
          "info": {
            "name": "Get Consent",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.yapily.com/consents/:consentId",
            "params": [
              {
                "name": "consentId",
                "value": "",
                "type": "path",
                "description": "__Mandatory__. The consent Id of the `Consent` to update."
              }
            ]
          },
          "docs": "Get consent using the consent Id"
        },
        {
          "info": {
            "name": "Delete Consent",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.yapily.com/consents/:consentId",
            "params": [
              {
                "name": "consentId",
                "value": "",
                "type": "path",
                "description": "__Mandatory__. The consent Id of the `Consent` to update."
              },
              {
                "name": "forceDelete",
                "value": "",
                "type": "query",
                "description": "__Optional__. Whether to force the deletion."
              }
            ]
          },
          "docs": "Delete a consent using the consent Id"
        },
        {
          "info": {
            "name": "Extend Consent",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.yapily.com/consents/:consentId/extend",
            "params": [
              {
                "name": "consentId",
                "value": "",
                "type": "path",
                "description": "__Mandatory__. The consent Id of the `Consent` to update."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Used to indicate to Yapily that reconfirmation has occurred for a given Consent, and to update lastUpdatedAt and reconfirmBy for that Consent. Returns the Consent."
        }
      ]
    }
  ],
  "bundled": true
}