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
To fetch customer registration information
ENDPOINTS
get
/v1/customers/{customerId}
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
Query parameters
Collapse
userIdType
string
no
Unique identifier of user id type. Allowed values:- CUSTOMER_ID - This is the FI Customer Id. LOGIN_ID - This is the 'loginId' of FI Customer - same as the username for logging in to the online application
userIdType
string
no
Unique identifier of user id type. Allowed values:- CUSTOMER_ID - This is the FI Customer Id. LOGIN_ID - This is the 'loginId' of FI Customer - same as the username for logging in to the online application
Path parameters
Collapse
customerId
string
required
Unique identifier of financial institution customer
Responses
Collapse
200
Customer information retrieved successfully
Response Body
{"userId":"4f251b9bf9c34da0add86fa00519180e","fiId":2509,"loginId":"cab123","userName":"user1","birthDate":"2022-03-31T00:00:00.000Z","failedLoginCount":1,"failedPasswordResetCount":1,"firstName":"test","middleName":"test","lastName":"test","fullName":"INSTITUTION USERS AUTOMATION USER","acceptedDisclosure":false,"billPayChecked":false,"userStatus":{"active":false,"onHold":false,"locked":false,"reset":false,"registered":false,"approved":false,"rejected":false,"invalidEmailId":false,"acceptedDisclosure":false,"needsToAcceptDisclosure":false,"needsToAcceptSecondaryDisclosure":false},"registrationDateTime":"2022-03-31T00:00:00.000Z","emailAddress":"test@xyz.com","userRole":"PRIMARY","userType":"RETAIL","customers":[{"customerId":"bfdf0fe66b334326b9f89f42c5af445c","memberNumber":"cmauser","customerType":"RETAIL","hostLoginId":1234}],"contactMethods":[{"id":5882388,"contactInfo":1234567890,"telephoneCountryCode":"1","protocol":"VOICE","activated":true,"enrolledDateTime":"2022-03-31T00:00:00.000Z","validated":true,"primary":true}],"postalAddresses":[{"address1":"12345 Mureau Road","address2":"address 2","address3":"address 3","city":"Calabasas","postalCode":91302,"primary":true,"index":1,"state":"CA","country":"US","type":"UNKNOWN"}]}
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 customers 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 'GET' \
'https://api.candescent.com/digitalbanking/ux-users/v1/customers/{customerId}' \
-H 'authorization: Bearer 18FaavwuGejYXBhj7grtrP57ZbCX' \
-H 'correlationid: f8187c63-678f-4f0c-9263-46723794661a' \
-H 'accept: application/json' \ RESPONSE
{"userId":"4f251b9bf9c34da0add86fa00519180e","fiId":2509,"loginId":"cab123","userName":"user1","birthDate":"2022-03-31T00:00:00.000Z","failedLoginCount":1,"failedPasswordResetCount":1,"firstName":"test","middleName":"test","lastName":"test","fullName":"INSTITUTION USERS AUTOMATION USER","acceptedDisclosure":false,"billPayChecked":false,"userStatus":{"active":false,"onHold":false,"locked":false,"reset":false,"registered":false,"approved":false,"rejected":false,"invalidEmailId":false,"acceptedDisclosure":false,"needsToAcceptDisclosure":false,"needsToAcceptSecondaryDisclosure":false},"registrationDateTime":"2022-03-31T00:00:00.000Z","emailAddress":"test@xyz.com","userRole":"PRIMARY","userType":"RETAIL","customers":[{"customerId":"bfdf0fe66b334326b9f89f42c5af445c","memberNumber":"cmauser","customerType":"RETAIL","hostLoginId":1234}],"contactMethods":[{"id":5882388,"contactInfo":1234567890,"telephoneCountryCode":"1","protocol":"VOICE","activated":true,"enrolledDateTime":"2022-03-31T00:00:00.000Z","validated":true,"primary":true}],"postalAddresses":[{"address1":"12345 Mureau Road","address2":"address 2","address3":"address 3","city":"Calabasas","postalCode":91302,"primary":true,"index":1,"state":"CA","country":"US","type":"UNKNOWN"}]}
{"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}
