Introduction
Accounts
Update contact info
Money Movement
Disclosures
Banking Images
Authentication
Alerts
Banking Activity
Unlock User
Legacy Authentication
Reset Password
Experience Group
Customer Information
Transactions
E-Statement Reports
.png)
Delete groups
ENDPOINTS
delete
/v3/groups/{groupId}
Header parameters
Collapse
transactionId
string
required
An ID that identifies this request. A unique identifier should be generated for each request made.
Body parameters
Collapse
{"customerId":"bfdf0fe66b334326b9f89f42c5af445c","accountType":"SAVINGS","limit":25,"offset":10,"fromDate":"04-30-2023","toDate":"05-30-2023"}
{"fiId":2509,"memberNumber":"updatecnct01","firstName":"John","middleName":"John","lastName":"Wick","emailAddress":"johnwick@gmail.com","contactInfo":{"id":5882388,"contactInfo":1234567890,"telephoneCountryCode":"1","protocol":"VOICE","activated":true,"enrolledDateTime":"2022-03-31T00:00:00.000Z","validated":true,"primary":true},"birthDate":"2023-10-31","channelType":"TPV_API","loginId":"lockeduser03","password":"test@123","acceptedDisclosure":true,"userType":"RETAIL","userRole":"PRIMARY","ssn":123456323,"motherMaidenName":"abcd","hostPassword":1234,"postalAddress":{"address1":"12345 Mureau Road","address2":"address 2","address3":"address 3","city":"Calabasas","postalCode":91302,"primary":true,"index":1,"state":"CA","country":"US","type":"UNKNOWN"}}
[{"id":"string","telephoneCountryCode":"string","contactInfo":"string","nickname":"string","protocol":"string","platform":"string","devicetype":"string","activated":"string","default":"string","enrolledDateTime":"string"}]
[{"id":"string","telephoneCountryCode":"string","contactInfo":"string","nickname":"string","protocol":"string","platform":"string","devicetype":"string","activated":"string","default":"string","enrolledDateTime":"string"}]
[{"Event":[{"fiCustomerId":"string","fiId":"string","eventType":"string","dataMap":[{"map":[{"key":"string","value":"string"}]}]}]}]
{"id":"string","fiId":"string","fiCustomerId":"string","eventTypeId":"string","fulfillment":"string","subscriptionEventConditionsMap":{"property1":{"map":[{"key":"string","value":"string"}]},"property2":{"map":[{"key":"string","value":"string"}]}},"subscriptionActions":{"property1":{"subscriptionAction":[{"name":"string","subscriptionActionAttributesMap":{"property1":{"map":[{"key":"string","value":"string"}]},"property2":{"map":[{"key":"string","value":"string"}]}}}]},"property2":{"subscriptionAction":[{"name":"string","subscriptionActionAttributesMap":{"property1":{"map":[{"key":"string","value":"string"}]},"property2":{"map":[{"key":"string","value":"string"}]}}}]}}}
{"id":"string","fiId":"string","fiCustomerId":"string","eventTypeId":"string","fulfillment":"string","subscriptionEventConditionsMap":{"property1":{"map":[{"key":"string","value":"string"}]},"property2":{"map":[{"key":"string","value":"string"}]}},"subscriptionActions":{"property1":{"subscriptionAction":[{"name":"string","subscriptionActionAttributesMap":{"property1":{"map":[{"key":"string","value":"string"}]},"property2":{"map":[{"key":"string","value":"string"}]}}}]},"property2":{"subscriptionAction":[{"name":"string","subscriptionActionAttributesMap":{"property1":{"map":[{"key":"string","value":"string"}]},"property2":{"map":[{"key":"string","value":"string"}]}}}]}}}
{"name":"My new user list","users":["some_member_id","another_member_id"]}
{"eventDetails":{"additionalInfo":{},"eventId":"string","eventNoticed":"2019-08-24T14:15:22Z","eventOccured":"2019-08-24T14:15:22Z","eventSource":"string","eventTags":["string"],"eventType":"string","institutionCustomerId":"string","institutionId":"string"},"eventDomainType":"string"}
{"additionalInfo":{},"institutionAlertPrefId":0,"alertTypeName":"string","channelTypeName":"string","institutionId":"string","alertOpted":true}
{"additionalInfo":{},"institutionAlertPrefId":0,"alertTypeName":"string","channelTypeName":"string","institutionId":"string","alertOpted":true}
{"additionalInfo":{},"alertOpted":true,"alertPreferenceAccountDetails":{"accountExternalId":"string","accountId":"string","cardNumber":"string"},"alertPreferenceDetails":{"alertPrefId":0,"alertTypeName":"string","channelTypeName":"string","externalId":"string","institutionCustomerId":"string","institutionId":"string"},"allowCallback":true,"defaultPreferences":true}
{"additionalInfo":{},"alertOpted":true,"alertPreferenceAccountDetails":{"accountExternalId":"string","accountId":"string","cardNumber":"string"},"alertPreferenceDetails":{"alertPrefId":0,"alertTypeName":"string","channelTypeName":"string","externalId":"string","institutionCustomerId":"string","institutionId":"string"},"allowCallback":true,"defaultPreferences":true}
{"institutionAlertTypeId":0,"alertTypeName":"string","channelsOptd":"string","reason":"string","statusOptd":"ACTIVE","institutionId":"string"}
{"institutionAlertTypeId":0,"alertTypeName":"string","channelsOptd":"string","reason":"string","statusOptd":"ACTIVE","institutionId":"string"}
{"additionalInfo":{"property1":"string","property2":"string"},"alertCategory":"string","alertTypeId":0,"alertTypeName":"string","applicableAccountTypes":"string","channels":"string","description":"string","displayAlertTypeName":"string","eventTypeDomain":"string","externalSystem":"string","institutionId":"string","status":"ACTIVE"}
{"additionalInfo":{"property1":"string","property2":"string"},"alertCategory":"string","alertTypeId":0,"alertTypeName":"string","applicableAccountTypes":"string","channels":"string","description":"string","displayAlertTypeName":"string","eventTypeDomain":"string","externalSystem":"string","institutionId":"string","status":"ACTIVE"}
{"alertTypeName":"string","alertTypeResourceId":0,"externalSystem":"string","institutionId":"string","lastUpdatedDttm":"string","locale":"string","state":"DRAFT","templateContents":[{"alertTemplateResourceId":0,"channelType":"EMAIL","templateContent":"string","templateContentType":"EMAIL_SUBJECT"}],"variableMap":{"property1":"string","property2":"string"}}
{"alertTypeName":"string","alertTypeResourceId":0,"externalSystem":"string","institutionId":"string","lastUpdatedDttm":"string","locale":"string","state":"DRAFT","templateContents":[{"alertTemplateResourceId":0,"channelType":"EMAIL","templateContent":"string","templateContentType":"EMAIL_SUBJECT"}],"variableMap":{"property1":"string","property2":"string"}}
{"userIdType":"CUSTOMER_ID","phoneNumber":{"oldPhoneNumber":"1234567890","oldCountryCode":"1","newPhoneNumber":9999999,"newCountryCode":"1"},"email":{"emailAddress":"jane.doe@gm.com"},"postalAddress":{"address1":"main street","address2":"main street","city":"bangalore","state":"karnataka","postalCode":89000,"country":"IN"}}
{"contactMethodId":"123310058","protocol":"SMS"}
{"fromAccountHolderId":"string","toAccountHolderId":"string","fromAccountId":"string","toAccountId":"string","amount":{"currencyCode":"AED","amount":0},"memo":"string","paymentOption":"DEFAULT","previousYearContribution":true,"status":"SUCCESS","confirmation":"string","fee":{"currencyCode":"AED","amount":0},"payoffAmount":{"currencyCode":"AED","amount":0},"notificationMessage":"string","id":"string","schedule":{"lifeType":"ENDDATE","startDate":"2019-08-24","endDate":"2019-08-24","numberOfExecutions":0,"frequency":"ONETIME","dayOfWeek":0,"daysOfMonth":[0],"nextExecutionDate":"2019-08-24","finalExecutionDate":"2019-08-24","remainingNumberOfExecutions":0}}
{"startTime":"2019-08-24T14:15:22Z","endTime":"2019-08-24T14:15:22Z","pageSize":200,"eventIds":["mfaChallenge","mfaEnrollment"],"userType":"retail","userIdType":"loginId","userId":"bbaadmin2","requestedAttributes":["ReqCtx_appId","ReqCtx_ipAddress","ReqCtx_locale","ReqCtx_loginId","ReqCtx_offeringId","ReqCtx_onBehalfOf","ReqCtx_region","ReqCtx_requestURI","ReqCtx_sessionId","ReqCtx_userProduct","ReqCtx_userType","cdiChallenged","cdiMode","challengeStatus","challengeType","invalidAttempts","passcodeSent","reason","source","step"],"additionalFilters":{"condition":"or","filters":[{"attributeId":"ReqCtx_appId","criteria":"equals","value":"USP"}],"subFilter":{"condition":"and","filters":[{"attributeId":"source","criteria":"equals","value":"web"}]}},"nextPageToken":"00f411a264961a7ec59e82999fb6375f"}
{ "FICustomer": { "id": { "value": "0", "type": "GUID" }, "fiId": { "value": "String" }, "memberNumber": "String", "person": { "personName": { "firstName": "String", "lastName": "String" }, "contactInfo": { "emailAddress": "String", "postalAddress": [ { "address1": "String", "address2": "String", "address3": "String", "city": "String", "state": "String", "postalCode": "String", "country": "String" } ], "phoneNumber": [ { "number": "String", "countryCode": "0" } ] }, "birthDate": "1900-01-01" }, "channelInfos": { "channelInfo": [ { "channelType": "String", "credential": { "loginId": "String", "password": "String" } } ] }, "acceptedDisclosure": "true/false", "userType": "String", "ssn": "String", "motherMaidenName": "String", "hostCredential": { "password": "String" } }}
{"groupId":"482cf7f8-3e59-4ccf-a996-97c79fd50cb1","groupName":"some group name","groupDescription":"description - some group description"}
{"groupId":"482cf7f8-3e59-4ccf-a996-97c79fd50cb1","groupName":"some group name","groupDescription":"description - some group description"}
{"type":"ADD","fileName":"string"}
{"grant_type":"password","username":"string","password":"string"}
{"grant_type":"string","username":"string","password":"string","scopes":"string","refresh_token":"string"}
{"activateEstatement":true,"accountId":"18fc507616c646048ea400138c8ac887"}
Path parameters
Collapse
groupId
string
required
An unique ID that identifies user group.
Responses
Collapse
200
OK
Response Body
{"code":"string","message":"string"}
400
Bad Request
Response Body
{"code":"string","message":"string"}
401
Unauthorized
Response Body
{"code":"string","message":"string"}
500
Internal Server Error
Response Body
{"code":"string","message":"string"}
CURL REQUEST
curl -X 'DELETE' \
'https://api.candescent.com/digitalbanking/groups/v3/groups/{groupId}' \
-H 'accept: application/json' \ RESPONSE
