Temenos Digital
Updated On 22 March 2025 | Min(s) read

Consent Management

The Consent Management stores the consents received from the Third Party Provider.

Name Description Introduced In
Customer Data Platform
getConsent This API allows the user to fetch the list of active and blocked consent data platform details for the user. 2021.07
updateConsent This API allows the user to update the consent type/sub types for a user. 2021.07
Payment Service Definition
getConsent This API allows the user to view the list of third parties to which user have given access to their accounts. 2021.07
updateConsent This API allows the user to update the consent. 2021.07
ukGetUserConsents This API retrieves the UK Geography consents. 2025.04
ukGetAllUserConsents This API retrieves UK consent details 2025.04
PSD2Consent This API retrieves the consent details for configured geography 2025.04
Object Data Models This Object Data Model describes the parameter name and other attribute details for Consent Management.  

Click here to view the object data model.

Customer Data Platform

 
Description: This API allows the user to fetch the list of active and blocked consent data platform details for the user.
Method: GET
URL: {base_url}/services/data/v1/ConsentManagement/operations/CDPConsent/getConsent
Security Level: Authenticated App User
Header Request:

X-Kony-Authorization

Body Request: 
{}
Response:

Parameters

arrangementId

Specifies the ID of the arrangement consent.

consentType

Specifies the type of consent.

consentGiven

Specifies if consent is provided or not provided.

consentTypeName

Specifies the name of consent type.

consentSubType

Specifies the sub category of consent.

consentSubTypeGiven

Specifies if consent is provided to sub category.

{
    "consentTypes": [{
        "arrangementId": "AA21105605CD",
        "consents": [{
            "consentType": "CREDITCHECK",
            "consentGiven": "NO",
            "consentTypeName": "Credit Checks"
        }, {
            "consentType": "PERSONALLOAN",
            "consentGiven": "NO",
            "consentTypeName": "Product Related Offers",
            "subTypes": [{
                "consentSubType": "EMAIL",
                "consentSubTypeGiven": "NO"
            }, {
                "consentSubType": "PHONE",
                "consentSubTypeGiven": "NO"
            }]
        }]
    }],
    "opstatus": 0,
    "httpStatusCode": 200
}
Error Code(s):
  • Error code : 12001
    Error message : "Logged in User is not authorized to perform this action."
  • Error code : 20042
    Error message : "No records found"
Enterprise Provider: Transact
Enterprise API:

{base_url}/v4.0.0/party/customers/$userID/consents?propertyClassId=CDP.CONSENT

Transact Artifact: Enquiry: CK.API.NOF.AA.CONSENT.TYPES.1.0.0

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
consentType consentType NA consentType
consentGiven consentGiven NA consentGiven
consentTypeName consentTypeName NA consentTypeName
consentSubType consentSubType NA consentSubType
consentSubTypeGiven consentSubTypeGiven NA consentSubTypeGiven
 
Description: This API allows the user to update the consent type/sub types for a user.
Method: PUT
URL: {base_url}/ services/data/v1/ConsentManagement/operations/CDPConsent/updateConsent
Security Level: Authenticated App User
Header Request:

X-Kony-Authorization

Body Request:

Parameters

arrangementId (Mandatory)

Specifies the unique ID of the arrangement.

consent (Mandatory)

Specifies the type of the consent.

consentTypes (Mandatory)

Specifies the group of consent type and consent given.

consentType (Mandatory)

Specifies the type of the consent.

consentGiven (Mandatory)

Specifies whether consent has been given or not.
{
    "arrangementId": "AA21105605CD",
    "consent": "{'consentTypes':[{'consentType':'CREDITCHECK','consentGiven':'YES'},{'consentType':'DATAPROFLING','consentGiven':'NO'},{'consentType':'DIRECTMKTING','consentGiven':'NO','subTypes':[{'subTypeConsentGiven':'NO','consentSubType':'EMAIL'},{'subTypeConsentGiven':'NO','consentSubType':'PHONE'},{'subTypeConsentGiven':'NO','consentSubType':'SMS'}]},{'consentType':'PERSONALLOAN','consentGiven':'NO','subTypes':[{'subTypeConsentGiven':'YES','consentSubType':'EMAIL'},{'subTypeConsentGiven':'YES','consentSubType':'PHONE'}]}]}"
}
Response:

Parameters

orderId

Specifies the order ID of the executed operation.

status

Specifies the status of the operation.

message

Specifies the message based on the status.

message

Specifies the error message when status is not success.
{
    "code": "",
    "orderId": "UCC21260G3414",
    "opstatus": 0,
    "message": "Service Request created successfully",
    "status": "SUCCESS",
    "httpStatusCode": 0
}
Error Code(s):
  • Error code : 12403
    Error message : "SECURITY EXCEPTION - UNAUTHORIZED ACCESS."
  • Error code : 12001
    Error message : "Logged in User is not authorized to perform this action."
Enterprise Provider: Service Request Microservice
Enterprise API:

{base_url}/v2.0.0/orders/party/$partyId/type/$type/subtype/$subtype/serviceRequest

Transact Artifact: Version: AA.ARRANGEMENT.ACTIVITY,AA.API.GENERIC.1.0.0

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
consentType consent.consentTypes.consentType consent consentType
consentGiven consent.consentTypes.consentGiven consent consentGiven
subTypeConsentGiven consent.consentTypes.consentType.subTypeConsentGiven consent subTypeConsentGiven
consentSubType consent.consentTypes.consentType.subType consent subType
NA arrangementId arrangementId arrangementId

Payment Service Definition

 
Description: This API allows the user to view the list of third parties to which user have given access to their accounts.
Method: GET
URL: {base_url}/services/data/v1/ConsentManagement/operations/PSD2Consent/getConsent
Security Level: Authenticated App User
Header Request:

X-Kony-Authorization

Body Request:

None
Response:

Parameters

arrangementId

Specifies the unique ID of arrangement.

shortName

Specifies the short name for given arrangement ID.

categoryId

Specifies the unique category ID.

consentType

Specifies the consentType.

consentId

Specifies the unique categoryId.

thirtpartyprovider

Specifies the third party provider name.

imagePath

Specifies the imagepath.

consentStatus

Specifies whether consent status is active or not.

thirtpartyproviderId

Specifies the unique Id of thirtpartyprovider.

tppStatus

Specifies the tppStatus.

validUntil

Specifies the validity date.
{
    "consentTypes": [{
        "arrangementId": "AA21105BB5Y3",
        "accountIBANs": [{
            "isConsentGiven": "YES",
            "accountIBAN": "GB40DEMO60161300119334",
            "shortName": "TEST",
            "categoryId": "1001",
            "consents": [{
                "consentType": "allPsd2"
            }]
        }],
        "consentId": "AAACT2110593CDQ76Z",
        "thirdpartyprovider": "saltedge",
        "imagePath": "",
        "consentStatus": "active",
        "thirdpartyproviderId": "PZANCA",
        "tppStatus": "",
        "validUntil": "06 AUG 2023"
    }],
    "opstatus": 0,
    "httpStatusCode": 200
}
Error Code(s):
  • Error code : 12001
    Error message : "Logged in User is not authorized to perform this action."
Enterprise Provider: Transact
Enterprise API: {base_url}v1.0.0/party/PSD2/customers/$userID/consents
Transact Artifact: Enquiry: PZ.API.GET.CONSENT.INFO.1.0.0

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
thirdpartyprovider thirdpartyprovider NA thirdpartyprovider
imagePath imagePath NA imagePath
validUntil validUntil NA validUntil
consentType consentType NA consentType
accountIBAN accountIBAN NA accountIBAN
shortName shortName NA shortName
 
Description: This API allows the user to update the consent.
Method: PUT
URL: {base_url}/services/data/v1/ConsentManagement/operations/PSD2Consent/updateConsent
Security Level: Authenticated App User
Header Request:

X-Kony-Authorization

Body Request:

Parameters

arrangementId (Mandatory)

Specifies the unique ID of the arrangement.

consentStatus (Mandatory)

Specifies the revokeStatus of the consentType.

{

    "arrangementId": "AA21105RKSBB",

    "consent": "{'consentStatuses': 

[{'consentStatus': 'active'}]}"

}
Response:

Parameters

orderId

Specifies the unique ID of the order,

status

Specifies the status of the operation.

message

Specifies the message based on the status.

{

    "code": "",
    "orderId": "UPC21246TA94O",
    "opstatus": 0,
    "message": "Service Request created successfully",
    "status": "SUCCESS",
    "httpStatusCode": 0

}
Error Code(s):
  • Error code : 12403
    Error message : "SECURITY EXCEPTION - UNAUTHORIZED ACCESS."
  • Error code : 12001
    Error message : "Logged in User is not authorized to perform this action."
Enterprise Provider MS ( Service Request Integrated)
Enterprise API

{base_url}/v2.0.0/orders/party/$partyId/type/$type/subtype/$subtype/serviceRequest

Transact Artifact: Version: AA.ARRANGEMENT.ACTIVITY,AA.API.GENERIC.1.0.0

Field Mapping

UI Field Experience API field MS API field Transact API field
consentStatus consentStatus consent consentStatus
NA arrangementId arrangementIs arrangementId
 
Description: This API retrieves the UK Geography consents by taking user id and consent status as input parameters.
Method: POST
URL: /services/T24AccountConsentServices/ukGetUserConsents
Security Level: Authenticated App User
Header Request:

NA
Body Request:  
{
    "userId" : "8587537735",
    "status" : "ACTIVE"
}
Response: 
{
    "consents": [
        {
            "statusChangeDate": "16 MAY 2024",
            "expiryDate": "20250601",
            "externalConsentId": "28355",
            "consentId": "AAACT24137ZX2L357W",
            "openBankingPermissions": "ACCOUNTS.BASIC, ACCOUNTS.DETAILED, ACCOUNT.BALANCES, ACCOUNTS.TXN.BASIC, ACCOUNTS.TXN.DETAILED, ACCOUNTS.SCHDPYMTS.DETAILED, ACCOUNTS.BEN.DETAILED, ACCOUNTS.BEN.BASIC, ACCOUNTS.DIRECTDEBITS, ACCOUNTS.SO.DETAILED, ACCOUNTS.SO.BASIC, ACCOUNTS.PARTY,",
            "accountDetails": [
                {
                    "accountId": "129337",
                    "name": "Current Account",
                    "sortCode": "601613",
                    "residenceId": "60161300129337",
                    "subAccount": "Current Accounts"
                }
            ],
            "consentStatus": "valid",
            "creationDate": "20240516",
            "tppName": "Priora Demo"
        }
    ],
    "opstatus": 0,
    "status": "success",
    "httpStatusCode": 200
}
Error Code(s): NA
 
Description: This method fetches the Active and Inactive consents for a user for UK geography.
Method: POST
URL: /services/UkConsentOrch/ukGetAllUserConsents
Security Level: Authenticated App User
Header Request:

NA
Body Request:  
{
    "userId" : "8587537735",
    "status" : "ACTIVE,INACTIVE"
}
Response: 
{
    "opstatus": 0,
    "LoopDataset": [
        {
            "consents": [
                {
                    "statusChangeDate": "16 MAY 2024",
                    "expiryDate": "20250601",
                    "externalConsentId": "28355",
                    "consentId": "AAACT24137ZX2L357W",
                    "openBankingPermissions": "ACCOUNTS.BASIC, ACCOUNTS.DETAILED, ACCOUNT.BALANCES, ACCOUNTS.TXN.BASIC, ACCOUNTS.TXN.DETAILED, ACCOUNTS.SCHDPYMTS.DETAILED, ACCOUNTS.BEN.DETAILED, ACCOUNTS.BEN.BASIC, ACCOUNTS.DIRECTDEBITS, ACCOUNTS.SO.DETAILED, ACCOUNTS.SO.BASIC, ACCOUNTS.PARTY,",
                    "accountDetails": [
                        {
                            "accountId": "129337",
                            "name": "Current Account",
                            "sortCode": "601613",
                            "residenceId": "60161300129337",
                            "subAccount": "Current Accounts"
                        }
                    ],
                    "consentStatus": "valid",
                    "creationDate": "20240516",
                    "tppName": "Priora Demo"
                }
            ],
            "opstatus": 0,
            "status": "success",
            "httpStatusCode": 200
        },
        {
            "consents": [
                {
                    "statusChangeDate": "16 MAY 2024",
                    "expiryDate": "20240516",
                    "externalConsentId": "28291",
                    "consentId": "AAACT24137M2BFYQWX",
                    "openBankingPermissions": "ACCOUNTS.BASIC, ACCOUNTS.DETAILED, ACCOUNT.BALANCES, ACCOUNTS.TXN.BASIC, ACCOUNTS.TXN.DETAILED, ACCOUNTS.SCHDPYMTS.DETAILED, ACCOUNTS.BEN.DETAILED, ACCOUNTS.BEN.BASIC, ACCOUNTS.DIRECTDEBITS, ACCOUNTS.SO.DETAILED, ACCOUNTS.SO.BASIC, ACCOUNTS.PARTY,",
                    "accountDetails": [
                        {
                            "accountId": "129313",
                            "name": "Current Account",
                            "sortCode": "601613",
                            "residenceId": "60161300129313",
                            "subAccount": "Current Accounts"
                        }
                    ],
                    "consentStatus": "expired",
                    "creationDate": "20240516",
                    "tppName": "Priora Demo"
                }
            ],
            "opstatus": 0,
            "status": "success",
            "httpStatusCode": 200
        }
    ]
}
Error Code(s): NA
 
Description: This method retrieves the consent details for configured geography.
Method: POST
URL: /services/data/v1/ConsentManagement/operations/PSD2Consent/getConsent
Security Level: Authenticated App User
Header Request:

NA
Body Request:  
{}
Response: 
	
{
    "consentTypes": [
        {
            "consentId": "AAACT24137ZX2L357W",
            "consentStatus": "valid",
            "tppName": "Priora Demo",
            "signUpService": "AISP",
            "statusChangeDate": "16 MAY 2024",
            "expiryDate": "20250601",
            "externalConsentId": "28355",
            "openBankingPermissions": [
                {
                    "category": "Accounts",
                    "description": "Account Name, Sort Code, Account Number, IBAN",
                    "type": "ACCOUNTS.DETAILED"
                },
                {
                    "category": "Balances",
                    "description": "Amount, Currency, Credit/Debit, Type of Balance, Date/Time, Credit Line.",
                    "type": "ACCOUNT.BALANCES"
                },
                {
                    "category": "Transactions",
                    "description": "Transaction Information on payments made both credits in and debits(Reference, Amount, Status, Booking Data Info, Value Date info, Transaction Code). Includes information about the payer/payee.",
                    "type": "ACCOUNTS.TXN.DETAILED"
                },
                {
                    "category": "Scheduled payments",
                    "description": "Scheduled dates, amount, reference. Includes information about the beneficiary.",
                    "type": "ACCOUNTS.SCHDPYMTS.DETAILED"
                },
                {
                    "category": "Beneficiaries",
                    "description": "Details of Beneficiaries account information (Name, Sort Code, Account).",
                    "type": "ACCOUNTS.BEN.DETAILED"
                },
                {
                    "category": "Direct Debits",
                    "description": "Mandate info, Status, Name, Previous payment information.",
                    "type": "ACCOUNTS.DIRECTDEBITS"
                },
                {
                    "category": "Standing Orders",
                    "description": "Details of Creditor Account Information (Name, Sort Code, Account)",
                    "type": "ACCOUNTS.SO.DETAILED"
                },
                {
                    "category": "Party",
                    "description": "The name of the account. Full Legal Name, Address, telephone numbers and email address as held by the bank/card issuer and party type (sole/joint etc.).",
                    "type": "ACCOUNTS.PARTY"
                }
            ],
            "accountDetails": [
                {
                    "accountId": "129337",
                    "name": "Current Account",
                    "sortCode": "601613",
                    "residenceId": "60161300129337",
                    "subAccount": "Current Accounts"
                }
            ],
            "creationDate": "20240516"
        },
        {
            "consentId": "AAACT24137M2BFYQWX",
            "consentStatus": "expired",
            "tppName": "Priora Demo",
            "signUpService": "AISP",
            "statusChangeDate": "16 MAY 2024",
            "expiryDate": "20240516",
            "externalConsentId": "28291",
            "openBankingPermissions": [
                {
                    "category": "Accounts",
                    "description": "Account Name, Sort Code, Account Number, IBAN",
                    "type": "ACCOUNTS.DETAILED"
                },
                {
                    "category": "Balances",
                    "description": "Amount, Currency, Credit/Debit, Type of Balance, Date/Time, Credit Line.",
                    "type": "ACCOUNT.BALANCES"
                },
                {
                    "category": "Transactions",
                    "description": "Transaction Information on payments made both credits in and debits(Reference, Amount, Status, Booking Data Info, Value Date info, Transaction Code). Includes information about the payer/payee.",
                    "type": "ACCOUNTS.TXN.DETAILED"
                },
                {
                    "category": "Scheduled payments",
                    "description": "Scheduled dates, amount, reference. Includes information about the beneficiary.",
                    "type": "ACCOUNTS.SCHDPYMTS.DETAILED"
                },
                {
                    "category": "Beneficiaries",
                    "description": "Details of Beneficiaries account information (Name, Sort Code, Account).",
                    "type": "ACCOUNTS.BEN.DETAILED"
                },
                {
                    "category": "Direct Debits",
                    "description": "Mandate info, Status, Name, Previous payment information.",
                    "type": "ACCOUNTS.DIRECTDEBITS"
                },
                {
                    "category": "Standing Orders",
                    "description": "Details of Creditor Account Information (Name, Sort Code, Account)",
                    "type": "ACCOUNTS.SO.DETAILED"
                },
                {
                    "category": "Party",
                    "description": "The name of the account. Full Legal Name, Address, telephone numbers and email address as held by the bank/card issuer and party type (sole/joint etc.).",
                    "type": "ACCOUNTS.PARTY"
                }
            ],
            "accountDetails": [
                {
                    "accountId": "129313",
                    "name": "Current Account",
                    "sortCode": "601613",
                    "residenceId": "60161300129313",
                    "subAccount": "Current Accounts"
                }
            ],
            "creationDate": "20240516"
        },
        {
            "consentId": "AAACT24137M2BFY67S",
            "consentStatus": "expired",
            "tppName": "Priora Demo",
            "signUpService": "AISP",
            "statusChangeDate": "16 MAY 2024",
            "expiryDate": "20240516",
            "externalConsentId": "28290",
            "openBankingPermissions": [
                {
                    "category": "Accounts",
                    "description": "Account Name, Sort Code, Account Number, IBAN",
                    "type": "ACCOUNTS.DETAILED"
                }
            ],
            "accountDetails": [
                {
                    "accountId": "129313",
                    "name": "Current Account",
                    "sortCode": "601613",
                    "residenceId": "60161300129313",
                    "subAccount": "Current Accounts"
                }
            ],
            "creationDate": "20240516"
        }
    ],
    "opstatus": 0,
    "httpStatusCode": 200
}
Error Code(s): NA
 
Parameter Name DataType Optional/Mandatory Description

 arrangementId

String

Mandatory

id of Consent Arrangement

consentType

String

Mandatory

type of consent

consentTypeName

String

Mandatory

name for consent type

consentSubType

String

Optional

subTypes of a consent

consentGiven

String

Mandatory

Yes/No
 
Parameter Name DataType Optional/Mandatory Description

 arrangementId

String

Mandatory

id of Consent Arrangement

accountIBAN

String

Mandatory

IBAN account

shortName

String

Mandatory

3rd party provider short name

consentType

String

Mandatory

type of consent

thirdpartyprovider

String

Mandatory

3rd party provider name

validUntil

String

Mandatory

validity date of consent

 

Copyright © 2020- Temenos Headquarters SA

Contact Us

knowledge@temenos.com

Published on :
Sunday, March 23, 2025 4:21:29 PM IST