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)
The scope for adding/updating disclosures is disclosures:write it is required in the body.
ENDPOINTS
post
/v1/institution-user-disclosures
Header parameters
Collapse
callingAppId
string
no
The id of the app or service calling the recipients service.
Authorization
string
required
An OAuth2 access token (in JWT format) that authorizes this request. The disclosures:write scope is required to access this API. Must be in the format Bearer {JWT}
transactionId
string
required
An ID that identifies this request. A unique identifier should be generated for each request made.
Body parameters
Collapse
Query parameters
Collapse
accountType
string
no
A valid DIAccountType value (mandatory for multi statement disclosures)
institutionCustomerId
string
no
The id of the user that this recipient is associated with. (mandatory for Business banking requests)
Responses
Collapse
200
Success
Response Body
{"institutionUserDisclosures":[{"institutionUserDisclosureId":"string","institutionId":"string","institutionUserId":"string","institutionDisclosureId":"string","institutionUserDisclosureStatus":"ENROLLED","institutionUserDisclosureStatusUpdateDateTime":"string","accountId":"string","institutionDisclosureName":"string"}]}
400
Bad request Possible causes: - Request header is too long. - Request is missing a transactionId header.
Response Body
{"code":"string","message":"string"}
401
Unauthorized Possible causes: - Full authentication was not provided in the request. - The authentication token that was sent in the request is invalid.
Response Body
{"code":"string","message":"string"}
403
Forbidden Possible causes: - The authentication provided does not authorize this request.
Response Body
{"code":"string","message":"string"}
500
Internal Server Error Possible causes: - Disclosures are not created successfully. - Disclosures are not retrieved successfully. - Various server errors
Response Body
{"code":"string","message":"string"}
501
Not implemented Possible causes: - Disclosure operation is not supported
Response Body
{"code":"string","message":"string"}
CURL REQUEST
curl -X 'POST' \
'https://api.candescent.com/digitalbanking/db-disclosures/v1/institution-user-disclosures' \
-H 'transactionid: SOME_STRING_VALUE' \
-H 'authorization: SOME_STRING_VALUE' \
-H 'callingappid: SOME_STRING_VALUE' \
-H 'accept: application/json' \ RESPONSE
