Private Individuals Endpoints
The below endpoints have been implemented to allow data manipulation operations on customer records such as creating or updating legal entity or individual customers, addresses, customer representatives, and groups.
FTOS_ACC_CB_AddUpdateIndividualCustomerThis endpoint replaces the FTOS_CB_AddUpdateIndividualCustomer endpoint. Please refer to the details below on how to use it and adapt your integrations accordingly.
Adds or updates a record in the Account entity representing an individual customer. The set of parameters sent via the request body determines the operation performed at the database level.
Syntax
{
"Request":{
"ActionName":"FTOS_ACC_CB_AddUpdateIndividualCustomer",
"Data": "{"CustomerInfo":{"customerInternalId":"<customerInternalId>","firstName":"<firstName>","lastName":"<lastName>","emailAddressType":"<emailAddressType>","phoneNumberType":"<phoneNumberType>","UniqueID":"<UniqueID>", "email":"<email>", "mobilePhone":"<mobilePhone>"}}"
},
"ApiInfo":{
"UserName":"<user_name>",
"Token":"<access_token>"
}
}Below is a list of the available parameters:
| Parameter | Description |
|---|---|
| firstName | Mandatory. The customer's firs name. |
| lastName | Mandatory. The customer's last name. |
| UniqueID | Mandatory. The customer's unique ID. |
| Mandatory. The email address of the customer. | |
| mobilePhone | Mandatory. The mobile phone number of the customer. |
| emailAddressType | Optional. The email address type. |
| phoneNumberType | Optional. The phone number type. |
Response
The response indicates the result of the code execution, specifically the result of creating or updating a record in the Account entity. If the record is created or updated successfully, the customerInternalId is returned.
FTOS_ACC_CB_AddUpdateCustomerAddressThis endpoint replaces the FTOS_CB_AddUpdateCustomerAddress endpoint. Please refer to the details below on how to use it and adapt your integrations accordingly.
Adds or updates a record in the Address entity representing a customer's address. The set of parameters sent via the request body determines the operation performed at the database level.
Syntax
The FTOS_ACC_CB_AddUpdateCustomerAddress endpoint is called from within the callAction endpoint. Visit the callAction page for more details.
{
"Request":{
"ActionName":"FTOS_ACC_CB_AddUpdateCustomerAddress",
"Data": "{"AddressInfo":{"addressIdentifier":"<addressIdentifier>","customerInternalId":"<customerInternalId>","addressType":"<addressType> ","country":"<country>","district":"<district>","city":"<city>","streetName":"<streetName>","streetNo":"<streetNo>","buildingNo":"<buildingNo>","floorNo":"<floorNo>","apartmentNo":"<apartmentNo>","postalCode":"<postalCode>"}}"
},
"ApiInfo":{
"UserName":"<user_name>",
"Token":"<access_token>"
}
}Below is a list of the available parameters:
| Parameter | Description |
|---|---|
| addressType | Mandatory. The type of the address. |
| country | Mandatory. The country of the address. |
| district | Mandatory. The district of the address. |
| city | Mandatory. The city of the address. |
| streetName | Mandatory. The street name of the address. |
| streetNo | Mandatory. The street number of the address. |
| buildingNo | Optional. The building number of the address. |
| floorNo | Optional. The floor of the address. |
| apartmentNo | Optional. The apartment number of the address. |
| postalCode | Mandatory. The postal code of the address. |
Response
The response indicates the result of the code execution, specifically the result of creating or updating a record in the Account entity. If the record is created or updated successfully, the addressIdentifier is returned.
FTOS_ACC_CB_AddUpdateCustomerRepresentativeThis endpoint replaces the FTOS_CB_AddUpdateCustomerRepresentative endpoint. Please refer to the details below on how to use it and adapt your integrations accordingly.
Adds or updates a record in the AccountRelContact entity representing a customer's representative. The set of parameters sent via the request body determines the operation performed at the database level.
Syntax
The FTOS_ACC_CB_AddUpdateCustomerRepresentative endpoint is called from within the callAction endpoint. Visit the callAction page for more details.
{
"Request":{
"ActionName":"FTOS_ACC_CB_AddUpdateCustomerRepresentative",
"Data": "{"CustomerRepresentativeInfo":{"customerInternalId":"<customerInternalId>","customerRepresentativeIdentifier":"<customerRepresentativeIdentifier>","customerRepresentativeNo":"<customerRepresentativeNo>","accountRelationType":"<accountRelationType>"}}"
},
"ApiInfo":{
"UserName":"<user_name>",
"Token":"<access_token>"
}
}Below is a list of the available parameters:
| Parameter | Description |
|---|---|
| customerInternalId | Optional. The customer's internal ID. |
| customerRepresentativeNo | Mandatory. The id of the customer representative. |
| accountRelationType | Mandatory. The relation type of the representative. Check theDependenciespage for possible values. |
| customerRepresentativeIdentifier | Optional. The customer representative identifier. |
Response
The response indicates the result of the code execution, specifically the result of creating or updating a record in the Account entity. If the record is created or updated successfully, the customerRepresentativeIdentifier is returned.
FTOS_ACC_CreateUpdateApplicationCreates or updates a record in the FTOS_ACC_Application representing the applications displayed at the customer's account level. The set of parameters sent via the request body determines the operation performed at the database level.
Syntax
{
"Request":{
"ActionName":"FTOS_ACC_CreateUpdateApplication",
"Data": "{"customerInternalId":"<customerInternalId>","url":"<url>","name":"<name>","bankingProduct":"<bankingProduct>","source":"<source>","businessStatus":"<businessStatus>", "externalId":"<externalId>", "amount":"<amount>", "currency":"<currency>"}"
},
"ApiInfo":{
"UserName":"<user_name>",
"Token":"<access_token>"
}
}Below is a list of the available parameters:
| Parameter | Description |
|---|---|
| customerInternalId | Mandatory. The customer's ID. |
| url | Mandatory. The application url. |
| name | Mandatory. The application name. |
| bankingProduct | Mandatory. The application banking product. |
| source | Mandatory. The application source. |
| businessStatus | Mandatory. The application status. |
| externalId | Mandatory. The application externalId. |
| amount | Optional. Application amount(positive value). |
| currency | Optional. Application currency. |
Response
The response indicates the result of the code execution, specifically the result of creating or updating a record in the Application entity.
FTOS_ACC_AddUpdateCustomerAgreementAdds or updates a record in the FTOS_ACC_Agreement representing the applications displayed at the customer's account level. The set of parameters sent via the request body determines the operation performed at the database level.
Syntax
{
"Request":{
"ActionName":"FTOS_ACC_AddUpdateCustomerAgreement",
"Data": "{"customerInternalId":"<customerInternalId>","agreementType":"<agreementType>","startDate":"<startDate>","sourceId":"<sourceId>","contractNo":"<contractNo>","AgreementId":"<AgreementId>", "externalId":"<externalId>"}"
},
"ApiInfo":{
"UserName":"<user_name>",
"Token":"<access_token>"
}
}Below is a list of the available parameters:
| Parameter | Description |
|---|---|
| customerInternalId | Mandatory. The customer's ID. |
| agreementType | Mandatory. The agreement type. |
| startDate | Mandatory. The agreement start date. |
| sourceId | Mandatory. The agreement source. |
| contractNo | Optional. The contract on which the agreement will be linked. |
| AgreementId | Optional. (only for update) An agreement Id to update fields. |
| externalId | Optional. Agreement external ID. |
Response
The response indicates the result of the code execution, specifically the result of creating or updating a record in the Agreement entity.
FTOS_ACC_AccountClientLifecycleDisplays records in the Lifecycle widget representing a view of the customer's purchase history.
Syntax
{
"Request":{
"ActionName":"FTOS_ACC_AccountClientLifecycle",
"Data": null
},
"ApiInfo":{
"UserName":"<user_name>",
"Token":"<access_token>"
}
}Parameters: null.
Response
The response indicates the result of the code execution, specifically the data displayed in the Lifecycle widget.
FTOS_ACC_AccountFlagsComputes the data displayed in the Account Flags widget. The set of parameters sent via the request body determines the operation performed at the database level.
Syntax
{
"Request":{
"ActionName":"FTOS_ACC_AccountFlags",
"Data": ":{"customerInternalId":"<customerInternalId>"}"
},
"ApiInfo":{
"UserName":"<user_name>",
"Token":"<access_token>"
}
}Below is a list of the available parameters:
| Parameter | Description |
|---|---|
| customerInternalId | Mandatory. The customer's ID. |
Response
The response indicates the result of the code execution, specifically the result of computing the data displayed in the the Account Flags widget.
FTOS_ACC_AccountHeaderComputes the data displayed at the account's header level. The set of parameters sent via the request body determines the operation performed at the database level.
Syntax
{
"Request":{
"ActionName":"FTOS_ACC_AccountHeader",
"Data": ":{"customerInternalId":"<customerInternalId>"}"
},
"ApiInfo":{
"UserName":"<user_name>",
"Token":"<access_token>"
}
}Below is a list of the available parameters:
| Parameter | Description |
|---|---|
| customerInternalId | Mandatory. The customer's ID. |
Response
The response indicates the result of the code execution, specifically the result of computing the data displayed at the account's header level,
FTOS_ACC_AccountPictureDisplays the customer's picture at the at the account's header level. The set of parameters sent via the request body determines the operation performed at the database level.
Syntax
{
"Request":{
"ActionName":"FTOS_ACC_AccountPicture",
"Data": ":{"customerInternalId":"<customerInternalId>"}"
},
"ApiInfo":{
"UserName":"<user_name>",
"Token":"<access_token>"
}
}Below is a list of the available parameters:
| Parameter | Description |
|---|---|
| customerInternalId | Mandatory. The customer's ID. |
Response
The response indicates the result of the code execution, specifically the result of displaying the customer's picture at the at the account's header level.
FTOS_ACC_AccountPendingActivitiesComputes the data displayed at the customer's account level in the Pending Activities widget. The set of parameters sent via the request body determines the operation performed at the database level.
Syntax
{
"Request":{
"ActionName":"FTOS_ACC_AccountPendingActivities",
"Data": ":{"customerInternalId":"<customerInternalId>"}"
},
"ApiInfo":{
"UserName":"<user_name>",
"Token":"<access_token>"
}
}Below is a list of the available parameters:
| Parameter | Description |
|---|---|
| customerInternalId | Mandatory. The customer's ID. |
Response
The response indicates the result of the code execution, specifically the result of computing the data displayed in the Pending Activities widget.
FTOS_ACC_ProductPortfolioComputes the data displayed in the Product Portfolio widget. The set of parameters sent via the request body determines the operation performed at the database level.
Syntax
{
"Request":{
"ActionName":"FTOS_ACC_ProductPortfolio",
"Data": ":{"customerInternalId":"<customerInternalId>"}"
},
"ApiInfo":{
"UserName":"<user_name>",
"Token":"<access_token>"
}
}Below is a list of the available parameters:
| Parameter | Description |
|---|---|
| customerInternalId | Mandatory. The customer's ID. |
Response
The response indicates the result of the code execution, specifically the result of computing the data displayed in the Product Portfolio widget.
FTOS_ACC_GetProductSuggestionsComputes the data displayed in the Product Suggestion widget. The set of parameters sent via the request body determines the operation performed at the database level.
Syntax
{
"Request":{
"ActionName":"FTOS_ACC_GetProductSuggestions",
"Data": ":{"accountId":"<accountId>"}"
},
"ApiInfo":{
"UserName":"<user_name>",
"Token":"<access_token>"
}
}Below is a list of the available parameters:
| Parameter | Description |
|---|---|
| accountId | Mandatory. The account's ID. |
Response
The response indicates the result of the code execution, specifically the result of computing the data displayed in the Product Suggestion widget.
FTOS_ACC_ProfileCompleteComputes the data displayed in the Profile Completion widget. The set of parameters sent via the request body determines the operation performed at the database level.
Syntax
{
"Request":{
"ActionName":"FTOS_ACC_ProfileComplete",
"Data": ":{"customerInternalId":"<customerInternalId>"}"
},
"ApiInfo":{
"UserName":"<user_name>",
"Token":"<access_token>"
}
}Below is a list of the available parameters:
| Parameter | Description |
|---|---|
| customerInternalId | Mandatory. The customer's ID |
Response
The response indicates the result of the code execution, specifically the result of computing the data displayed in the in the Profile Completion widget.
FTOS_ACC_AccountProfitabilityPIComputes the data displayed in the Profitability widget. The set of parameters sent via the request body determines the operation performed at the database level.
Syntax
{
"Request":{
"ActionName":"FTOS_ACC_AccountProfitabilityPI",
"Data": ":{"customerInternalId":"<customerInternalId>","indicatorName":"<indicatorName>"}"
},
"ApiInfo":{
"UserName":"<user_name>",
"Token":"<access_token>"
}
}Below is a list of the available parameters:
| Parameter | Description |
|---|---|
| customerInternalId | Mandatory. The customer's ID. |
indicatorName | Mandatory. The name of the indicator |
Response
The response indicates the result of the code execution, specifically the result of computing the data displayed in the Profitability widget.
FTOS_ACC_AccountRecentInteractionsComputes the data displayed in the Recent Interactions widget. The set of parameters sent via the request body determines the operation performed at the database level.
Syntax
{
"Request":{
"ActionName":"FTOS_ACC_AccountRecentInteractions",
"Data": ":{"customerInternalId":"<customerInternalId>","fromDate":"<fromDate>","toDate":"<toDate>","channels":"<channels>"}"
},
"ApiInfo":{
"UserName":"<user_name>",
"Token":"<access_token>"
}
}Below is a list of the available parameters:
| Parameter | Description |
|---|---|
| customerInternalId | Mandatory. The customer's ID. |
| ifromDate | Mandatory. The start date |
| toDate | Mandatory. The end date. |
| channels | Optional. Array with channels on which the activity was made. |
Response
The response indicates the result of the code execution, specifically the result of computing the data in the Recent Interactions widget.
FTOS_ACC_AccountRevenuesPIComputes the data displayed in the Revenues widget. The set of parameters sent via the request body determines the operation performed at the database level.
Syntax
{
"Request":{
"ActionName":"FTOS_ACC_AccountRevenuesPI",
"Data": ":{"customerInternalId":"<customerInternalId>","startDate":"<startDate>","endDate":"<endDate>"}"
},
"ApiInfo":{
"UserName":"<user_name>",
"Token":"<access_token>"
}
}Below is a list of the available parameters:
| Parameter | Description |
|---|---|
| customerInternalId | Mandatory. The customer's ID. |
| startDate | Mandatory. The start date |
| endDate | Mandatory. The end date. |
Response
The response indicates the result of the code execution, specifically the result of computing the data displayed in the Revenues widget.
FTOS_ACC_GetCustomerTransactionValuesComputes the data displayed in the Transactions widget. The set of parameters sent via the request body determines the operation performed at the database level.
Syntax
{
"Request":{
"ActionName":"FTOS_ACC_GetCustomerTransactionValues",
"Data": ":{"customerInternalId":"<customerInternalId>","startDate":"<startDate>","endDate":"<endDate>","transactionIndicators":"<transactionIndicators>","direction":"<direction>","interIntra":"<interIntra>","currencyId":"<currencyId>"}"
},
"ApiInfo":{
"UserName":"<user_name>",
"Token":"<access_token>"
}
}Below is a list of the available parameters:
| Parameter | Description |
|---|---|
| customerInternalId | Mandatory. The customer's ID. |
| startDate | Mandatory. The start date |
| endDate | Mandatory. The end date. |
| transactionIndicators | Optional. Array with indicators name |
| direction | Direction of the indicator(Incoming/Outgoing) |
| interIntra | Optional. Inter/Intra |
| currencyId | Optional. The currency of the indicator |
Response
The response indicates the result of the code execution, specifically the result of computing the data displayed in the Transactions widget.