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
Api to fetch the opt-in data
ENDPOINTS
post
/v1/reports/e-statements
Header parameters
Collapse
correlationId
string
required
UUID that uniquely identifies the request. This id allows the request to be traced through the entire request and reponse flow.
Authorization
string
required
Standard OAuth 2.0 access token. A string composed of 'Bearer' + '(space)' + '{token}'
Body parameters
Collapse
{"customerId":"bfdf0fe66b334326b9f89f42c5af445c","accountType":"SAVINGS","limit":25,"offset":10,"fromDate":"04-30-2023","toDate":"05-30-2023"}
Responses
Collapse
200
Statement preference updated successfully
Response Body
{"totalCount":100,"StatementOptInReport":[{"userId":"bfdf0fe66b334326b9f89f42c5af445c","userName":"John Doe","accountNumber":9900002001,"accountType":"SAVINGS","optInEstatement":true,"optInPaperStatement":false,"optInDateTime":"1985-05-22T00:00:00-07:00"}]}
400
Bad Request
Response Body
{"status":"Message","message":"Verbose, plain language description of the problem","code":3000}
401
Unauthorized
Response Body
{"status":"Message","message":"Verbose, plain language description of the problem","code":3000}
403
Forbidden
Response Body
{"status":"Message","message":"Verbose, plain language description of the problem","code":3000}
404
No entitled account found
Response Body
{"status":"Message","message":"Verbose, plain language description of the problem","code":3000}
500
Server error
Response Body
{"status":"Message","message":"Verbose, plain language description of the problem","code":3000}
CURL REQUEST
curl -X 'POST' \
'https://api.candescent.com/digitalbanking/ux-users/v1/reports/e-statements' \
-H 'authorization: Bearer 18FaavwuGejYXBhj7grtrP57ZbCX' \
-H 'correlationid: f8187c63-678f-4f0c-9263-46723794661a' \
-H 'accept: application/json' \
-H 'content-type: application/json' \
-d '{
"customerId": "bfdf0fe66b334326b9f89f42c5af445c",
"accountType": "SAVINGS",
"limit": 25,
"offset": 10,
"fromDate": "04-30-2023",
"toDate": "05-30-2023"
}';RESPONSE
{"totalCount":100,"StatementOptInReport":[{"userId":"bfdf0fe66b334326b9f89f42c5af445c","userName":"John Doe","accountNumber":9900002001,"accountType":"SAVINGS","optInEstatement":true,"optInPaperStatement":false,"optInDateTime":"1985-05-22T00:00:00-07:00"}]}
{"status":"Message","message":"Verbose, plain language description of the problem","code":3000}
{"status":"Message","message":"Verbose, plain language description of the problem","code":3000}
{"status":"Message","message":"Verbose, plain language description of the problem","code":3000}
{"status":"Message","message":"Verbose, plain language description of the problem","code":3000}
{"status":"Message","message":"Verbose, plain language description of the problem","code":3000}
