- POST /v1/customers/register : This API facilitates the creation and registration of a user account for online banking. It serves as the initial step in the signup process, enabling new customers to create their account quickly and efficiently
- .GET /v1/customers/{customerId}:accounts :
This API allows the retrieval of a customer's digital banking accounts information. - GET /v1/customers/{customerId}/contact-methods?userIdType={userIdType}:
This API allows the retrieval of a customer's digital banking profile information.
Example Code:
Request: API to create/register a user for online banking
- POST /v1/customers/register
Sample JSON Request Body:
{
"fiId": "2509",
"memberNumber": "updatecnct01",
"firstName": "John",
"middleName": "John",
"lastName": "Wick",
"emailAddress": "johnwick@gmail.com",
"contactInfo": {
"id": "5882388",
"contactInfo": "1234567890",
"telephoneCountryCode": "1",
"protocol": "VOICE",
"activated": true,
"enrolledDateTime": "2022-03-31T00:00:00.000Z",
"validated": true,
"primary": true
},
"birthDate": "2023-10-31",
"channelType": "TPV_API",
"loginId": "lockeduser03",
"password": "test@123",
"acceptedDisclosure": true,
"userType": "RETAIL",
"userRole": "PRIMARY",
"ssn": "123456323",
"motherMaidenName": "abcd",
"hostPassword": "1234",
"postalAddress": {
"address1": "12345 Mureau Road",
"address2": "address 2",
"address3": "address 3",
"city": "Calabasas",
"postalCode": "91302",
"primary": true,
"index": "1",
"state": "CA",
"country": "US",
"type": "UNKNOWN"
}
}
Response Status: 201 OK
Request: API to fetch Accounts registration information
- GET /v1/customers/{customerId}:accounts :
Sample JSON Response:
[
{
"accountHidden": true,
"accountNumber": "9900002001",
"accountStatus": {
"open": false,
"closed": false,
"negativeBalance": false,
"delinquent": false,
"inCollection": false,
"overLimit": false,
"writtenOff": false,
"creditBalance": false,
"paymentCoupon": false,
"retirementPlan": false,
"retPlanOwnedByDeceased": false,
"approved": false,
"notApproved": false,
"deleted": false,
"verified": false
},
"accountType": {
"DIAccountType": "SAVINGS",
"fiRawAccountType": 0,
"fiAccountType": 0,
"description": "Money Market"
},
"achCount": 0,
"balance": {
"availableBalance": {
"amount": 105,
"currencyCode": "USD"
},
"currentBalance": {
"amount": 105,
"currencyCode": "USD"
}
},
"billPayAccountNumber": "string",
"billPayId": "string",
"category": "DEPOSIT",
"currentYearEligibleContribution": {
"amount": 105,
"currencyCode": "USD"
},
"currentYearMaxContribution": {
"amount": 105,
"currencyCode": "USD"
},
"description": "string",
"diAccountType": 0,
"escrowPriorYearToDate": {
"amount": 105,
"currencyCode": "USD"
},
"escrowYearToDate": {
"amount": 105,
"currencyCode": "USD"
},
"fiAccountTypeDesc": "string",
"fiRawAccountType": 0,
"fiAccountType": 0,
"customerId": "string",
"fiId": "string",
"historyAllowed": true,
"hostAccountType": "string",
"id": "string",
"interestPriorYearToDate": {
"amount": 105,
"currencyCode": "USD"
},
"interestRate": 0,
"lastDepositAmount": {
"amount": 105,
"currencyCode": "USD"
},
"lastDividendAmount": {
"amount": 105,
"currencyCode": "USD"
},
"lastInterestPaymentAmount": {
"amount": 105,
"currencyCode": "USD"
},
"lastInterestPaymentDate": "string",
"lastStatementStartDate": "string",
"lastStatementEndDate": "string",
"lastYearEligibleContribution": {
"amount": 105,
"currencyCode": "USD"
},
"lastYearMaxContribution": {
"amount": 105,
"currencyCode": "USD"
},
"micrNumber": "string",
"nickName": "string",
"nonQualifiedRate": 0,
"overDraftBillPayValue": "string",
"overDraftExternalMortgageAccountValue": "string",
"rdcAccountValue": 0,
"overdraftAccountNumber": "string",
"overdraftAvailableAmount": {
"amount": 105,
"currencyCode": "USD"
},
"overdraftLimit": {
"amount": 105,
"currencyCode": "USD"
},
"ownershipType": "PRIMARY",
"posCount": 0,
"primaryHolderId": "string",
"primaryHolderName": "string",
"regDLimits": {
"maxTransferCount": 1,
"maxCheckCount": 2,
"maxRegDCount": 1,
"hostTransferCount": 2,
"hostCheckCount": 2
},
"rewardsCount": 0,
"taxPriorYearToDate": {
"amount": 105,
"currencyCode": "USD"
},
"taxYearToDate": {
"amount": 105,
"currencyCode": "USD"
},
"tier1BalanceDesc": "string",
"tier1QualifiedRate": 0,
"tier2BalanceDesc": "string",
"tier2QualifiedRate": 0,
"totalFundsAvailable": {
"amount": 105,
"currencyCode": "USD"
},
"tpvReference": "string",
"transferRestriction": "EXCLUDE_ALL",
"accountTransactions": [
{
"accountId": "123456",
"amount": {
"amount": 105,
"currencyCode": "USD"
},
"amountToEscrow": {
"amount": 105,
"currencyCode": "USD"
},
"amountToInterest": {
"amount": 105,
"currencyCode": "USD"
},
"amountToPrincipal": {
"amount": 105,
"currencyCode": "USD"
},
"checkImageIdentifier": "string",
"checkImageLocator": "string",
"checkNumber": 0,
"checkNumberStr": "string",
"creditTransaction": true,
"depositSlipIdentifier": "string",
"description": "string",
"effectiveDate": "string",
"fee": {
"amount": 105,
"currencyCode": "USD"
},
"fiId": "string",
"id": "string",
"ledgerBalance": {
"amount": 105,
"currencyCode": "USD"
},
"memo": "string",
"micr": "string",
"isPending": false,
"persistentTnum": false,
"transactionDate": "string",
"transactionId": "string",
"transactionNumber": "string",
"transactionType": "string"
}
]
}
]
Response Status: 200 OK
Request: API to retrieve digital banking profile information for a customer.
- GET /v1/customers/{customerId}/contact-methods?userIdType={userIdType}:
Sample 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"
}
]
}
Response Status: 200 OK