Use Cases
Scenario : Adding a new user into the Candescent Digital Banking platform (used for online account opening).
The purpose of this API is to create an interface that third-party vendors could consume in order to complete the DI registration process.
Common use cases include:
- Online account opening vendors who want to let users complete the DI registration process at the end of their online account opening process
- Mobile banking vendors who provide their product to financial institutions using DI online banking services
- The registration process should be completed such that users can log in as if they had completed the DI-owned/managed registration form directly
The user in this case is the customer of FI.
Register User for Online Banking
POST /registration/v4/fis/{di_fiid}/fiCustomers
Request
Path Parameters:
di_fiid
: Unique identifier for the FI
Headers:
Authorization
: The bearer access token from the Authentication API
di_tid
: A UUID string used as unique identifier for this token request
offering_id
: Uniquely identifies the name of the client app making the request
Content-Type
: application/json
Body (Required Fields):
- First Name
- Last Name
- Social Security Number
- Date of Birth
- Address1
- Street
- City
- State
- Zip Code
- Country
- Phone Number - DI should populate this into MFA like we do in registration form
- Email Address
- Mother's Maiden Name
Sample Response:
{
"FICustomer": {
"id": {
"value": "0",
"type": "GUID"
},
"fiId": {
"value": "01111"
},
"memberNumber": "468531842",
"person": {
"personName": {
"lastName": "User",
"firstName": "Test"
},
"contactInfo": {
"emailAddress": "development@[test.com](http://test.com)",
"postalAddress": [
{
"address1": "100 Main Street",
"city": "Miles City",
"state": "MT",
"postalCode": "59301",
"country": "US"
}
],
"phoneNumber": [
{
"number": "1234567890"
}
]
},
"birthDate": "2000-01-01"
},
"channelInfos": {
"channelInfo": [
{
"channelType": "TPV_API",
"credential": {
"loginId": "xxxxx",
"password": "te$tPswrd1234"
}
}
]
},
"acceptedDisclosure": "false",
"userType": "PRIMARY",
"ssn": "111111111",
"motherMaidenName": "4",
"hostCredential": {
"password": "1234"
}
}
}
Example Code
Register User for Online Banking
Sample Response:
{
"FICustomer": {
"id": {
"value": "5fc1ce845418409d95d20be19892fed1",
"type": "GUID"
},
"fiId": {
"value": "01111"
},
"memberNumber": "468531842",
"authId": "32ba75fc903411ec9b5342010a63a196",
"hostCredential": {
"loginId": "xxxxx"
},
"person": {
"personName": {
"lastName": "User",
"firstName": "Test",
"middleName": "",
"titlePrefix": "",
"suffix": ""
},
"contactInfo": {
"phoneNumber": [
{
"number": "1234567890"
}
],
"emailAddress": "development@[t](http://stockmanbank.com)est.com",
"postalAddress": [
{
"address1": "100 Main Street",
"city": "Miles City",
"state": "MT",
"postalCode": "59301",
"country": "US"
}
]
},
"birthDate": "2000-01-01-08:00"
},
"channelInfos": {
"channelInfo": [
{
"channelType": "TPV_API",
"credential": {
"loginId": "xxxxx"
}
}
]
},
"billPayEnabled": false,
"destinations": {
"destination": [
{
"contactInfo": "1234567890",
"protocol": "VOICE",
"activated": true
}
]
},
"acceptedDisclosure": false,
"userType": "PRIMARY",
"ssn": "111111111",
"motherMaidenName": "4"
}
}