External Users
| Name | Description | Introduced in |
|---|---|---|
| verifyExistingPassword | This API verifies the existing password. | 2021.01 |
| checkUserEnrolled | This API checks the enrolled user. | 2021.01 |
| UpdateDetails | This API updates the details. | 2021.01 |
| Update ExternalUsers | This API updates the external users. | 2021.10 |
| Get ExternalUsers | This API gets the external users. | 2021.10 |
| Object Data Model | This Object Data Model describes the parameter name and other attribute details for External Users. |
verifyExistingPassword
| Description: | This API verifies the existing password. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/ExternalUserManagement/operations/ExternalUsers/verifyExistingPassword |
| Security Level: | Authenticated App User |
| Header Request: |
X-Kony-Authorization |
| Body Request: |
Parameters password(Mandatory) {
"password": "Kony@1234"
}
|
| Response: | {
"result": "The user is verified",
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): | NA |
| Enterprise Provider: | NA |
| Enterprise API: |
NA |
Field Mapping
| UI Field | Experience API Field | MS API Field | Transact API Field |
|---|---|---|---|
| NA | password | NA | NA |
| NA | result | NA | NA |
checkUserEnrolled
| Description: | This API checks the enrolled user. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/ExternalUserManagement/operations/ExternalUsers/checkUserEnrolled |
| Security Level: | Authenticated App User |
| Header Request: |
X-Kony-Authorization |
| Body Request: |
Parameters LastName(Mandatory) Ssn(Mandatory) DateOfBirth(Mandatory) {
"LastName": "Bailey",
"Ssn": "065452564",
"DateOfBirth": "1985-05-05"
}
|
| Response: | {
"isUserEnrolled": "true",
"result": "User Already Enrolled"
}
|
| Error Code(s): |
|
| Enterprise Provider: | NA |
| Enterprise API: |
NA |
Field Mapping
| UI Field | Experience API Field | MS API Field | Transact API Field |
|---|---|---|---|
| NA | dateOfBirth | NA | NA |
| NA | LastName | NA | NA |
| NA | ssn | NA | NA |
| NA | isUserEnrolled | NA | NA |
| NA | result | NA | NA |
UpdateDetails
| Description: | This API updates the details. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/ExternalUserManagement/ExternalUsers/UpdateDetails |
| Security Level: | Authenticated App User |
| Header Request: |
X-Kony-Authorization |
| Body Request: |
Parameters EmailIds(Mandatory) {
"EmailIds": "[{'isPrimary':'1','isAlertsRequired':'0','value':'test@gmail.com','Extension':'Personal'}]",
"userName": "",
"modifiedByName": ""
}
|
| Response: | {
orderId: “ANE21279URVW8”,
opstatus: 0,
status: “SUCCESS”,
httpStatusCode: 0
}
|
| Error Code(s): |
|
| Enterprise Provider: | NA |
| Enterprise API: |
NA |
Field Mapping
| UI Field | Experience API Field | MS API Field | Transact API Field |
|---|---|---|---|
| NA | Addresses | NA | NA |
| NA | coreCustomerID | NA | NA |
| NA | TaxId | NA | NA |
| NA | phoneNumbers | NA | NA |
| NA | preferredContactTime | NA | NA |
| NA | modifiedByName | NA | NA |
| NA | identities | NA | NA |
| NA | EmailIds | NA | NA |
| NA | phoneNumbers | NA | NA |
| NA | deleteAddressID | NA | NA |
| NA | FirstName | NA | NA |
| NA | zipcode | NA | NA |
| NA | dateOfBirth | NA | NA |
| NA | userName | NA | NA |
| NA | RiskStatus | NA | NA |
| NA | deleteCommunicationID | NA | NA |
| NA | isTypeBusiness | NA | NA |
| NA | preferredContactMethod | NA | NA |
| NA | phoneCountryCode | NA | NA |
| NA | Customer_id | NA | NA |
| NA | isEagreementSigned | NA | NA |
| NA | isAlertsRequired | NA | NA |
| NA | LastName | NA | NA |
| NA | partyID | NA | NA |
| NA | startDate | NA | NA |
| NA | status | NA | NA |
| NA | communicationType | NA | NA |
| NA | orderId | NA | NA |
UpdateExternalUsers
| Description: | This API verifies the updates the external users. |
| Method: | PATCH |
| URL: | {base_url}/services/data/v1/ExternalUserManagement/objects/ExternalUsers |
| Security Level: | Authenticated App User |
| Header Request: |
X-Kony-Authorization |
| Body Request: | {
"userName": "",
"password": "",
"email": "",
"phone": "12345678",
"secondaryphone": "",
"secondaryemail": "",
"oldpassword": "",
"default_account_deposit": "",
"default_account_payments": "",
"default_account_transfers": "",
"alertsTurnedOn": "",
"areAccountStatementTermsAccepted": "",
"areDepositTermsAccepted": "",
"addressLine1": "",
"addressLine2": "",
"city": "",
"country": "",
"state": "",
"zipcode": "",
"pin": "",
"default_account_cardless": "",
"default_account_billPay": "",
"default_from_account_p2p": "",
"default_to_account_p2p": "",
"secondaryphone2": "",
"secondaryemail2": "",
"userImage": "",
"default_account_wire": "",
"showBillPayFromAccPopup": "",
"phoneCountryCode": "",
"phoneExtension": ""
}
|
| Response: | {
“success”: “Successful”,
“opstatus”:0,
“httpStstusCode”:0
}
|
| Error Code(s): |
NA |
| Enterprise Provider: | NA |
| Enterprise API: |
NA |
Field Mapping
| UI Field | Experience API Field | MS API Field | Transact API Field |
|---|---|---|---|
| NA | country | NA | NA |
| NA | areAccountStatementTermsAccepted | NA | NA |
| NA | default_account_wire | NA | NA |
| NA | city | NA | NA |
| NA | default_from_account_p2p | NA | NA |
| NA | default_account_transfers | NA | NA |
| NA | default_to_account_p2p | NA | NA |
| NA | default_account_billPay | NA | NA |
| NA | secondaryemail2 | NA | NA |
| NA | password | NA | NA |
| NA | userImage | NA | NA |
| NA | pin | NA | NA |
| NA | addressLine1 | NA | NA |
| NA | addressLine2 | NA | NA |
| NA | default_account_payments | NA | NA |
| NA | state | NA | NA |
| NA | default_account_deposit | NA | NA |
| NA | secondaryphone | NA | NA |
| NA | NA | NA | |
| NA | secondaryemail | NA | NA |
| NA | oldpassword | NA | NA |
| NA | userName | NA | NA |
| NA | zipcode | NA | NA |
| NA | default_account_cardless | NA | NA |
| NA | secondaryphone2 | NA | NA |
| NA | phone | NA | NA |
| NA | alertsTurnedOn | NA | NA |
| NA | areDepositTermsAccepted | NA | NA |
| NA | showBillPayFromAccPopup | NA | NA |
| NA | ExternalUsers | NA | NA |
| NA | errmsg | NA | NA |
| NA | success | NA | NA |
GetExternalUsers
| Description: | This API gets the external users. |
| Method: | GET |
| URL: | {base_url}/services/data/v1/ExternalUserManagement/objects/ExternalUsers |
| Security Level: | Authenticated App User |
| Header Request: |
X-Kony-Authorization |
| Body Request: | {}
|
| Response: | {
"records": [
{
"addressLine1": "",
"alertsTurnedOn": "false",
"bankName": "Infinity",
"dateOfBirth": "1992-04-01",
"DateOfBirth": "1992-04-01",
"phone": "+91-9299997757",
"email": "surendra.gontla@temenos.com",
"city": "",
"zipcode": "",
"default_account_billPay": "125512",
"default_account_deposit": "125512",
"default_account_payments": "125512",
"default_account_transfers": "125512",
"isPinSet": "false",
"lastlogintime": "2021-10-25 11:41:38.0",
"userfirstname": "SURENDRA",
"userId": "3085544850",
"userlastname": "NATH",
"LastName": "NATH",
"userName": "2277144949",
"isWireTransferActivated": "false",
"isWireTransferEligible": "true",
"showBillPayFromAccPopup": "false",
"isP2PActivated": "true",
"isBillPaySupported": "true",
"isBillPayActivated": "false",
"feedbackUserId": "c828e639-e4fb-4764-a110-c33e1b9e1610",
"isSecurityQuestionConfigured": "false",
"isActivationLinkSent": "false",
"customerStatus": "SID_CUS_ACTIVE",
"isCustomerEnrolled": "true",
"isAssociated": "true",
"Addresses": [
{
"Address_id": "1",
"AddressType": "ADR_TYPE_HOME",
"CountryCode": "IN",
"isPrimary": "true"
},
{
"Address_id": "04a57f9c-41ab-4f77-8296-d29ad3b1106e",
"AddressType": "ADR_TYPE_HOME",
"AddressLine1": "nuiop",
"ZipCode": "600027",
"City_id": "tpur",
"RegionName": "Tamil Nadu",
"Region_id": "IN-TN",
"RegionCode": "IN-TN",
"CountryName": "India",
"Country_id": "IN",
"CountryCode": "IN",
"isPrimary": "false"
}
],
"ContactNumbers": [
{
"id": "CUS_1272578902",
"Type_id": "COMM_TYPE_PHONE",
"isPrimary": "false",
"Value": "5555555",
"phoneNumber": "5555555",
"Extension": "Home",
"phoneCountryCode": "+1",
"isTypeBusiness": "0",
"isAlertsRequired": "false"
},
{
"id": "1",
"Type_id": "COMM_TYPE_PHONE",
"isPrimary": "true",
"Value": "9299997757",
"phoneNumber": "9299997757",
"Extension": "Mobile",
"phoneCountryCode": "+91"
}
],
"EmailIds": [
{
"id": "CUS_1693260985",
"Type_id": "COMM_TYPE_EMAIL",
"isPrimary": "false",
"Value": "arji@gmsip.com",
"Extension": "Personal",
"isTypeBusiness": "0",
"isAlertsRequired": "false"
},
{
"id": "1",
"Type_id": "COMM_TYPE_EMAIL",
"isPrimary": "true",
"Value": "surendra.gontla@temenos.com"
}
],
"CoreCustomers": [
{
"coreCustomerID": "801138",
"coreCustomerName": "SURENDRAGONTLA",
"isBusiness": "false",
"isPrimary": "false",
"contractId": "7151043900",
"contractName": "SURENDRA NATH"
}
]
}
],
"opstatus": 0,
"httpStatusCode": 200
}
|
| Error Code(s): |
|
| Enterprise Provider: | T24 |
| Enterprise API: |
T24 - /v3.0.0/party/customers/$userID T24 - /v1.0.0/party/customers/$userID/contactDetails |
Field Mapping
| UI Field | Experience API Field | MS API Field | Transact API Field |
|---|---|---|---|
| NA | ExternalUsers | NA | NA |
| NA | addressLine1 | NA | NA |
| NA | addressLine2 | NA | NA |
| NA | alertsTurnedOn | NA | NA |
| NA | areAccountStatementTermsAccepted | NA | NA |
| NA | areDepositTermsAccepted | NA | NA |
| NA | bankName | NA | NA |
| NA | city | NA | NA |
| NA | coutry | NA | NA |
| NA | currencyCode | NA | NA |
| NA | dateOfBirth | NA | NA |
| NA | phone | NA | NA |
| NA | NA | NA | |
| NA | zipcode | NA | NA |
| NA | default_account_billPay | NA | NA |
| NA | default_account_cardless | NA | NA |
| NA | default_account_deposit | NA | NA |
| NA | default_account_payments | NA | NA |
| NA | default_account_transfers | NA | NA |
| NA | default_from_account_p2p | NA | NA |
| NA | default_to_account_p2p | NA | NA |
| NA | isPinSet | NA | NA |
| NA | lastlogintime | NA | NA |
| NA | phoneExtension | NA | NA |
| NA | phoneCountryCode | NA | NA |
| NA | role | NA | NA |
| NA | secondaryemail | NA | NA |
| NA | secondaryemail2 | NA | NA |
| NA | secondaryphone | NA | NA |
| NA | secondaryphone2 | NA | NA |
| NA | Ssn | NA | NA |
| NA | state | NA | NA |
| NA | FirstName | NA | NA |
| NA | id | NA | NA |
| NA | UserImage | NA | NA |
| NA | LastName | NA | NA |
| NA | UserName | NA | NA |
| NA | default_account_wire | NA | NA |
| NA | isWireTransferActivated | NA | NA |
| NA | isWireTransferEligible | NA | NA |
| NA | UserImageURL | NA | NA |
| NA | MaritalStatus_id | NA | NA |
| NA | NoOfDependents | NA | NA |
| NA | SpouseName | NA | NA |
| NA | spouselastname | NA | NA |
| NA | Gender | NA | NA |
| NA | showBillPayFromAccPopup | NA | NA |
| NA | isP2PActivated | NA | NA |
| NA | isP2PSupported | NA | NA |
| NA | isBillPaySupported | NA | NA |
| NA | isBillPayActivated | NA | NA |
| NA | feedbackUserId | NA | NA |
| NA | isVIPCustomer | NA | NA |
| NA | PreferredTimeAndMethod | NA | NA |
| NA | PreferredContactMethod | NA | NA |
| NA | PreferredContactTime | NA | NA |
| NA | isSecurityQuestionConfigured | NA | NA |
| NA | isActivationLinkSent | NA | NA |
| NA | customerStatus | NA | NA |
| NA | isCustomerEnrolled | NA | NA |
| NA | isAssociated | NA | NA |
| NA | Address_id | NA | NA |
| NA | AddressType | NA | NA |
| NA | CityName | NA | NA |
| NA | addressCity | NA | NA |
| NA | City_id | NA | NA |
| NA | RegionName | NA | NA |
| NA | Region_id | NA | NA |
| NA | RegionCode | NA | NA |
| NA | CountryName | NA | NA |
| NA | Country_id | NA | NA |
| NA | CountryCode | NA | NA |
| NA | isPrimary | NA | NA |
| NA | isTypeBusiness | NA | NA |
| NA | Type_id | NA | NA |
| NA | Value | NA | NA |
| NA | Extension | NA | NA |
| NA | Description | NA | NA |
| NA | isAlertsRequired | NA | NA |
| NA | coreCustomerId | NA | NA |
| NA | coreCustomerName | NA | NA |
| NA | isBusiness | NA | NA |
| NA | contractId | NA | NA |
| NA | contractName | NA | NA |
| NA | identifiers | NA | NA |
| NA | type | NA | NA |
| NA | status | NA | NA |
| NA | issuingAuthority | NA | NA |
| NA | identifierNumber | NA | NA |
| NA | issuedDate | NA | NA |
| NA | expiryDate | NA | NA |
| NA | issuingCountry | NA | NA |
| NA | holderName | NA | NA |
| NA | documentTagId | NA | NA |
| NA | employmentReference | NA | NA |
| NA | jobTitle | NA | NA |
| NA | employerName | NA | NA |
| NA | startDate | NA | NA |
| NA | endDate | NA | NA |
| NA | employerSegment | NA | NA |
| NA | employerOfficePhoneIdd | NA | NA |
| NA | employerOfficePhone | NA | NA |
| NA | employerOfficeEmail | NA | NA |
| NA | salary | NA | NA |
| NA | salaryInCurrency | NA | NA |
| NA | salaryFrequency | NA | NA |
| NA | primaryEmployment | NA | NA |
Object Data Model
External Users
| Parameter Name | DataType | Optional/Mandatory | Description |
|---|---|---|---|
| accountNumber | String | Mandatory | accountNumber |
| accountType | String | Mandatory | accountType |
| Addresses | String | Mandatory | Addresses |
| addressId | String | Mandatory | addressId |
| addressLine1 | String | Mandatory | addressLine1 |
| addressLine2 | String | Mandatory | addressLine2 |
| addressType | String | Mandatory | addressType |
| alertsTurnedOn | String | Mandatory | alertsTurnedOn |
| areAccountStatementTermsAccepted | String | Mandatory | areAccountStatementTermsAccepted |
| areDepositTermsAccepted | String | Mandatory | areDepositTermsAccepted |
| bankName | String | Mandatory | bankName |
| cardNumber | String | Mandatory | cardNumber |
| city | String | Mandatory | city |
| communication | String | Mandatory | communication |
| communicationType | String | Mandatory | communicationType |
| ContactNumbers | String | Mandatory | ContactNumbers |
| contractId | String | Mandatory | contractId |
| coreCommunication | String | Mandatory | coreCommunication |
| coreCustomerID | String | Mandatory | coreCustomerID |
| coreCustomerName | String | Mandatory | coreCustomerName |
| CoreCustomers | String | Mandatory | CoreCustomers |
| country | String | Mandatory | country |
| currencyCode | String | Mandatory | currencyCode |
| Customer_id | String | Mandatory | Customer_id |
| cvv | String | Mandatory | cvv |
| dateOfBirth | String | Mandatory | dateOfBirth |
| default_account_billPay | String | Mandatory | default_account_billPay |
| default_account_cardless | String | Mandatory | default_account_cardless |
| default_account_deposit | String | Mandatory | default_account_deposit |
| default_account_payments | String | Mandatory | default_account_payments |
| default_account_transfers | String | Mandatory | default_account_transfers |
| default_account_wire | String | Mandatory | default_account_wire |
| default_from_account_p2p | String | Mandatory | default_from_account_p2p |
| default_to_account_p2p | String | Mandatory | default_to_account_p2p |
| deleteAddressID | String | Mandatory | deleteAddressID |
| deleteCommunicationID | String | Mandatory | deleteCommunicationID |
| description | String | Mandatory | description |
| String | Mandatory | ||
| EmailIds | String | Mandatory | EmailIds |
| errCode | String | Mandatory | errCode |
| errmsg | String | Mandatory | errmsg |
| errorCode | String | Mandatory | errorCode |
| errorMessage | String | Mandatory | errorMessage |
| featureRequest | String | Mandatory | featureRequest |
| feedbackUserId | String | Mandatory | feedbackUserId |
| FirstName | String | Mandatory | FirstName |
| gender | String | Mandatory | gender |
| Id | String | Mandatory | Id |
| Identities | String | Mandatory | Identities |
| idmConfig | String | Mandatory | idmConfig |
| isAlertsRequired | String | Mandatory | isAlertsRequired |
| isBillPayActivated | String | Mandatory | isBillPayActivated |
| isBillPaySupported | String | Mandatory | isBillPaySupported |
| isBusiness | String | Mandatory | isBusiness |
| isCombinedUser | String | Mandatory | isCombinedUser |
| isEagreementSigned | String | Mandatory | isEagreementSigned |
| isEmailEnabled | String | Mandatory | isEmailEnabled |
| isEngageProvisioned | String | Mandatory | isEngageProvisioned |
| isP2PActivated | String | Mandatory | isP2PActivated |
| isP2PSupported | String | Mandatory | isP2PSupported |
| isPhoneEnabled | String | Mandatory | isPhoneEnabled |
| isPinSet | String | Mandatory | isPinSet |
| isPreferredAddress | String | Mandatory | isPreferredAddress |
| isPrimary | String | Mandatory | isPrimary |
| isSecurityQuestionConfigured | String | Mandatory | isSecurityQuestionConfigured |
| isTypeBusiness | String | Mandatory | isTypeBusiness |
| isUserEnrolled | String | Mandatory | isUserEnrolled |
| isUserExists | String | Mandatory | isUserExists |
| isVIPCustomer | String | Mandatory | isVIPCustomer |
| isWireTransferActivated | String | Mandatory | isWireTransferActivated |
| isWireTransferEligible | String | Mandatory | isWireTransferEligible |
| lastlogintime | String | Mandatory | lastlogintime |
| LastName | String | Mandatory | LastName |
| maritalStatus | String | Mandatory | maritalStatus |
| modifiedByName | String | Mandatory | modifiedByName |
| noOfDependents | String | Mandatory | noOfDependents |
| oldpassword | String | Mandatory | oldpassword |
| otp | String | Mandatory | otp |
| partyID | String | Mandatory | partyID |
| password | String | Mandatory | password |
| phone | String | Mandatory | phone |
| phoneCountryCode | String | Mandatory | phoneCountryCode |
| phoneExtension | String | Mandatory | phoneExtension |
| phoneNumbers | String | Mandatory | phoneNumbers |
| pin | String | Mandatory | pin |
| preferredContactMethod | String | Mandatory | preferredContactMethod |
| preferredContactTime | String | Mandatory | preferredContactTime |
| rating | String | Mandatory | rating |
| referenceID | String | Mandatory | referenceID |
| result | String | Mandatory | result |
| RiskStatus | String | Mandatory | RiskStatus |
| role | String | Mandatory | role |
| secondaryemail | String | Mandatory | secondaryemail |
| secondaryemail2 | String | Mandatory | secondaryemail2 |
| secondaryphone | String | Mandatory | secondaryphone |
| secondaryphone2 | String | Mandatory | secondaryphone2 |
| securityKey | String | Mandatory | securityKey |
| serviceKey | String | Mandatory | serviceKey |
| showBillPayFromAccPopup | String | Mandatory | showBillPayFromAccPopup |
| spouseFirstName | String | Mandatory | spouseFirstName |
| spouseLastName | String | Mandatory | spouseLastName |
| ssn | String | Mandatory | ssn |
| startDate | String | Mandatory | startDate |
| state | String | Mandatory | state |
| status | String | Mandatory | status |
| success | String | Mandatory | success |
| TaxId | String | Mandatory | TaxId |
| userfirstname | String | Mandatory | userfirstname |
| userId | String | Mandatory | userId |
| userImage | String | Mandatory | userImage |
| userImageURL | String | Mandatory | userImageURL |
| userlastname | String | Mandatory | userlastname |
| userName | String | Mandatory | userName |
| zipcode | String | Mandatory | zipcode |
Field Name
|
Application/Table name
In this topic