Register New Customer
Registers a new customer for online banking via third party applications. This API provides the same registration process used in Candescent Digital Banking. No scope required.
Requires V1 OAuth Token
Common Use Cases:
- Online banking vendors registering users after digital account opening
- Mobile banking vendors with FIs using Candescent Digital Banking
- Developers extending Candescent Digital Banking functionality
Required Personal Data:
| Field | Requirements |
|---|---|
| First Name | Max 39 characters |
| Last Name | Max 39 characters |
| SSN | Exactly 9 digits |
| Date of Birth | Format: yyyy-mm-dd |
| Address | Street, City, State (2 chars for US), Zip, Country |
| Phone Number | 10 digits |
| Max 64 characters | |
| Mother's Maiden Name | Max 128 characters |
Username Policy:
- Length: 8-20 characters (configurable: min 6, max 20)
- Cannot be only numbers, can be all letters
- Allowed special characters:
@$*_-=.!~ - No spaces allowed
- Cannot match member number
Password Policy:
- Length: 6-32 characters (configurable)
- Must contain characters from at least 2 of: Letters, Numbers, Special characters
- No spaces allowed
- Cannot be a substring of the username
Disclosures: The API will make calls to the appropriate disclosure records on file for the FI. Registration will not complete without user acceptance of required disclosures.
Logging: Performs global logging under RegistrationUser event with channel type TPV_API and user product THIRD_PARTY_REGISTRATION.
Request/Response Format:
The request body must be wrapped in a FICustomer root element.
The response is always returned as application/xml.
Request
Responses
- 200
- 400
- 409
- 500
User is successfully created. Returns the customer profile with the assigned GUID.
Bad Request. Common error codes:
| Error Code | Condition |
|---|---|
| 26340 | Could not create record in database |
| 26214 | Too many destinations passed |
| 20006 | Member number is not alphanumeric, length is 0 or >16, channel info not passed (valid value: TPV_API), SSN not found, first + last name >39 chars |
| 220001 | SSN is not 9 digits |
| 220002 | First name is more than 39 characters |
| 220003 | Last name is more than 39 characters |
| 220005 | Middle name is more than 39 characters |
| 220006 | Primary email is more than 64 characters |
| 220007 | Postal code not found in input |
| 220008 | City not found in input |
| 220009 | State not found, beyond 128 chars, or not 2 chars for US |
| 220010 | Street/Address1 not found or more than 128 characters |
| 220011 | Country not found in input |
| 220012 | Mother's Maiden Name not found or more than 128 characters |
| 220013 | Proper DOB not found in input |
| 220014 | Phone number is missing |
| 220015 | UserID must be 6-256 characters, allowed special characters: @$*_-=.!~, no spaces |
| 220016 | Login ID and Member number cannot be the same |
| 26201 | LoginID is already taken |
| 220019 | Login should be within preconfigured range |
| 220018 | Invalid user password |
Conflict. Error codes:
- 26330: User's online registration is already in progress (duplicate registration request)
- 26331: User is already a registered user
Backend server does not respond, or some of the service is down.