APIs

This section covers the details of the APIs supported by Consent Management microservices.

CREATE CONSENT
This API is used to store the provided consent.

POST/holdings/parties/{partyid}/consentypes/{type}/consents

Request
{
  {
  "consent": {
    "bankName": " string",
    "consentGiven": " string",
    "purpose": [
      " string"
    ],
    "creationDate": "2020-03-30",
    "expiresDate": "2020-03-30",
    "periodDays": 0,
    "consentBlock": "string",
    "blockDate": "2020-03-30",
    "consentWithdraw": "string",
    "withdrawDate": "2020-03-30",
    "withdrawNotes": "string"
  }
}
Response
{
  "Status": "Success"
}
GET CONSENTS
This API is used to return all the consent details you provide.

GET/ holdings /parties/{partyid}/consentypes/{type}/consents

Response
{
  "consent": [
    {
      "consentType": " string ",
      "bankName": "string",
      "partyId": "string",
      "consentGiven": "string",
      "purpose": [
        "string"
      ],
      "creationDate": "2020-03-30",
      "expiresDate": "2020-03-30",
      "periodDays": 0,
      "consentBlock": "string",
      "blockDate": "2020-03-30",
      "consentWithdraw": "string",
      "withdrawDate": "2020-03-30",
      "withdrawNotes": "string"
    }
  ]
}
UPDATE CONSENT
This API is used to withdraw, revoke the consent by providing withdraw notes with the withdraw dates.

PUT/holdings /parties/{partyid}/consentypes/{type}/revokeconsent

Request
{
  "consent": {
    "bankName": "string",
    "consentGiven": "string",
    "purpose": [
      "string"
    ],
    "creationDate": "2020-03-30",
    "expiresDate": "2020-03-30",
    "periodDays": 0,
    "consentBlock": "string",
    "blockDate": "2020-03-30",
    "consentWithdraw": "string",
    "withdrawDate": "2020-03-30",
    "withdrawNotes": "string"
  }
}
Response
{
  "Status": " Success "
}

Bookmark Name Actions
BACK

In this topic

Feedback
x

Are you sure you want to log-off?