production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/customers/phone/manage
post /v1/customers/phone/manage
create-customer-phone
To create the customer phone record for the customer
This API is used to create the customer phone record for the customer
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Required in header
string
Content-Types that are sent in the request
ChannelId
Required in header
string
Channel where request originated
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified during application registration
sid
Required in header
string
SessionId sent by Consumer
createCustomerPhoneRequest
Optional in body
object
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/phone/manage
put /v1/customers/phone/manage
update-customer-phone
To update the customer phone record for the customer
This API is used to update the customer phone record for the customer
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Required in header
string
Content-Types that are sent in the request
ChannelId
Required in header
string
Channel where request originated
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified during application registration
sid
Required in header
string
SessionId sent by Consumer
updateCustomerPhoneRequest
Optional in body
object
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
PUT https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/phone/manage
/v1/customers/email/manage
post /v1/customers/email/manage
create-customer-email
To create the customer email record for the customer
This API is used to create the customer email record for the customer
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Required in header
string
Content-Types that are sent in the request
ChannelId
Required in header
string
Channel where request originated
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified during application registration
sid
Required in header
string
SessionId sent by Consumer
createCustomerEmailRequest
Optional in body
object
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/email/manage
put /v1/customers/email/manage
update-customer-email
To update the customer email record for the customer
This API is used to update the customer email record for the customer
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Required in header
string
Content-Types that are sent in the request
ChannelId
Required in header
string
Channel where request originated
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified during application registration
sid
Required in header
string
SessionId sent by Consumer
updateCustomerEmailRequest
Optional in body
object
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
PUT https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/email/manage
/v1/customers/contacts/manage/retrieve
post /v1/customers/contacts/manage/retrieve
retrieve-customer-contact-detail
To get thecontact record for the customer
This api is used to get the contact record for the customer
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Required in header
string
Content-Types that are sent in the request
ChannelId
Required in header
string
Channel where request originated
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified during application registration
sid
Required in header
string
SessionId sent by Consumer
retrieveCustomerContactRequest
Optional in body
object
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/contacts/manage/retrieve
Definitions
{
"type": "object",
"properties": {
"oneTimePasswordToken": {
"type": "string",
"example": "17364892",
"description": "Challenge token generated by the hardToken or softToken assigned to the client."
}
},
"required": [
"oneTimePasswordToken"
]
}
{
"type": "object",
"properties": {
"jwtToken": {
"type": "string",
"example": "kkhljsdf87sdifskjfsdhkf8fsdf",
"description": "JWT to validate customer email."
}
},
"required": [
"jwtToken"
]
}
{
"type": "object",
"properties": {
"customerId": {
"description": "Unique identifier of the customer",
"type": "string",
"example": "123456789012"
},
"agentId": {
"description": "Executive Number of the agent who is creating/updating the records",
"type": "string",
"example": "000001494120"
},
"productCode": {
"description": "Product Code",
"type": "string",
"example": "0066"
},
"productInstrument": {
"description": "Product Instrument",
"type": "string",
"example": "06"
},
"security": {
"$ref": "#/definitions/Security"
},
"phone": {
"$ref": "#/definitions/PhoneDE"
}
},
"required": [
"customerId"
]
}
{
"type": "object",
"properties": {
"extensionNumber": {
"description": "Phone Extension Number",
"type": "string",
"example": "87654"
},
"lastFailedContactDate": {
"description": "last call date",
"type": "string",
"format": "date",
"example": "2019-12-22"
},
"lastUpdatedDate": {
"description": "Modification date of the record",
"type": "string",
"format": "date",
"example": "2019-12-26"
},
"phoneCountryCode": {
"description": "country code of the phone",
"type": "string",
"example": "52"
},
"phoneNumber": {
"description": "Phone number of the customer",
"type": "string",
"example": "5544332211"
},
"phoneTypeDescription": {
"description": "Description of type of phone",
"type": "string",
"example": "Home"
},
"subAreaCode": {
"description": "Sub area of the phone information",
"type": "string",
"example": "10000003"
},
"updatedAreaCode": {
"description": "Updated area code",
"type": "string",
"example": "0003"
},
"certificationType": {
"description": "Type of phone certification. Level 1, Level 2, Level 3",
"type": "string",
"example": "004"
},
"certificationRejectedCount": {
"description": "Number of times the certification of phone has been declined or rejected",
"type": "integer",
"example": 5
},
"certificationAppliedType": {
"description": "Way in which certification is applied to the customer",
"type": "string",
"example": "4"
},
"certificationCampaignId": {
"description": "Mobile phone-certified campaign number",
"type": "string",
"example": "00000004"
},
"certificationDate": {
"description": "Phone certification date",
"type": "string",
"format": "date",
"example": "2019-09-24"
},
"lastActivityDate": {
"description": "Date of last access of the user to banking",
"type": "string",
"format": "date",
"example": "2019-09-27"
},
"customerCallCount": {
"description": "Counter that identifies number of attempts made by a customer to call the bank. The information comes from the front. Usually the initial response is set to Zero.",
"type": "integer",
"example": 2
},
"lineOfBusinessCode": {
"description": "Medium through which the phone was created (CAT, App or other medium)",
"type": "string",
"example": "2"
},
"originApplicationId": {
"description": "Origin system from where the phone was registered. OneEclipse, AO etc.",
"type": "string",
"example": "0005"
},
"mobileCarrierCode": {
"description": "Mobile carrier or service provider",
"type": "string",
"example": "5"
},
"phoneRegisteredDaysCount": {
"description": "Number of days since the phone number has been registered by the customer",
"type": "integer",
"example": 5
},
"phoneAdditionalDetail": {
"$ref": "#/definitions/PhoneAdditionalDetail"
}
},
"required": [
"phoneNumber"
]
}
{
"type": "object",
"properties": {
"channelCode": {
"description": "Phone Media. Telephone registration or modification channel.",
"type": "string",
"example": "01"
},
"originDepartmentId": {
"description": "Key of the department of origin of the phone. Ex- Billing, Clarifications, etc.",
"type": "string",
"example": "0123"
},
"departmentId": {
"description": "Department or area that adds or modifies the telephone data",
"type": "string",
"example": "0123"
},
"originCountryCode": {
"description": "Country of origin of the mobile carrier of the phone",
"type": "string",
"example": "01"
},
"phoneNumberPreferenceType": {
"description": "Refers to the type of the preference of the phone. Ex- Home, Office, Messages, etc.",
"type": "string",
"example": "0123"
},
"applicationSource": {
"description": "Process by which the phone was captured or updated. Example- branch, Fraud etc.",
"type": "string",
"example": "01"
},
"channelPriority": {
"description": "The channel with the highest priority that captured the phone.",
"type": "string",
"example": "01"
},
"applicationId": {
"description": "Front application that captured or updated the phone. Ex- OneEclipse etc.",
"type": "string",
"example": "0123"
},
"authenticationMethodCode": {
"description": "The method used for authentication of this telephone when it is last added or modified. Ex- OTP, ATM etc.",
"type": "string",
"example": "01"
},
"primaryAuthenticationMethodCode": {
"description": "The method used for authentication of this telephone when it was added the first time. Ex- OTP, ATM etc.",
"type": "string",
"example": "01"
},
"declineAuthenticationCode": {
"description": "This is the reason code for why the phone was not verified",
"type": "string",
"example": "01"
},
"phoneAuthenticationDate": {
"description": "Phone verification date",
"type": "string",
"format": "date",
"example": "2019-09-22"
},
"phoneRestrictedCode": {
"description": "The code that tells the restrictions on the phone, if any. Ex- if it is blacklisted, REUS, Article 44.",
"type": "string",
"example": "0123"
},
"alertEnabledFlag": {
"description": "Flag indicates if the alerts and notifications are enabled on the phone.",
"type": "boolean",
"example": true
},
"digitalChannelEnrollmentFlag": {
"description": "Flag indicates if the phone uses any Digital Banking service. Ex- BNE, etc.",
"type": "boolean",
"example": true
},
"cubAlertEnabledFlag": {
"description": "Indicates if the phone is registered to CUB (anti identity theft prevention) alerts and notifications",
"type": "boolean",
"example": true
},
"cubProcessFlag": {
"description": "Indicates if the CUB process or flow is to be followed to retrieve the phone data or the normal flow",
"type": "boolean",
"example": true
},
"preferredCallTime": {
"description": "Preferred time to call",
"type": "string",
"example": "14:00:00"
},
"accountNumber": {
"description": "Account number to which the phone is related.",
"type": "string",
"example": "1234567890123456"
},
"branchId": {
"description": "Unique identifier of the office or branch of the agent.",
"type": "string",
"example": "0123"
}
},
"required": [
"applicationId"
]
}
{
"type": "object",
"properties": {
"messageText": {
"description": "Text message for the addition/modification",
"type": "string",
"example": "Record added successfully"
},
"registrationDate": {
"description": "creation Date",
"type": "string",
"format": "date",
"example": "2019-12-26"
}
}
}
{
"type": "object",
"properties": {
"customerId": {
"description": "Unique identifier of the customer",
"type": "string",
"example": "123456789012"
},
"security": {
"$ref": "#/definitions/SecurityDetail"
},
"email": {
"$ref": "#/definitions/EmailDE"
}
},
"required": [
"customerId",
"security"
]
}
{
"type": "object",
"properties": {
"emailAddress": {
"description": "Email Address",
"type": "string",
"example": "algo@algo.com"
},
"emailSequenceNumber": {
"description": "Sequence number of the electronic address",
"type": "integer",
"format": "int32",
"example": 1234
},
"channelType": {
"description": "To indicate what type of channel used for communication with involved party. Ex- email, fax etc.",
"type": "string",
"example": "02",
"maxLength": 2
},
"emailUsageCount": {
"description": "Usage number of the electronic address",
"type": "integer",
"format": "int32",
"example": 1234
},
"serviceProvider": {
"description": "This is the provider of the services like yahoo, Hotmail, gmail, etc.",
"type": "string",
"example": "0000"
},
"emailAdditionalDetail": {
"$ref": "#/definitions/EmailAdditionalDetail"
}
},
"required": [
"emailAddress"
]
}
{
"type": "object",
"properties": {
"channelCode": {
"description": "Email Media. Email registration or modification channel.",
"type": "string",
"example": "01"
},
"departmentId": {
"description": "Department or area that adds or modifies the email data",
"type": "string",
"example": "0123"
},
"applicationSource": {
"description": "Process by which the email was captured or updated. Example- branch, Fraud etc.",
"type": "string",
"example": "01"
},
"channelPriority": {
"description": "The channel with the highest priority that captured the email.",
"type": "string",
"example": "01"
},
"applicationId": {
"description": "Front application that captured or updated the email. Ex- OneEclipse etc.",
"type": "string",
"example": "0123"
},
"authenticationMethodCode": {
"description": "The method used for authentication of this email when it is last added or modified. Ex- OTP, ATM etc.",
"type": "string",
"example": "01"
},
"primaryAuthenticationMethodCode": {
"description": "The method used for authentication of this email when it was added the first time. Ex- OTP, ATM etc.",
"type": "string",
"example": "01"
},
"declineAuthenticationCode": {
"description": "This is the reason code for why the email was not verified",
"type": "string",
"example": "01"
},
"emailAuthenticationDate": {
"description": "The date of the email verification.",
"type": "string",
"format": "date",
"example": "2020-03-11"
},
"emailStatus": {
"description": "Status of the email.",
"type": "string",
"example": "01"
},
"emailType": {
"description": "Category of the electronic address. Like Personal, office etc.",
"type": "string",
"example": "02"
},
"emailRestrictedCode": {
"description": "The code that tells the restrictions on the email, if any. Ex- if it is blacklisted, REUS, Article 44.",
"type": "string",
"example": "0123"
},
"lastContactedDate": {
"description": "Date Of last successful email contact made to the customer",
"type": "string",
"format": "date",
"example": "2020-03-12"
},
"alertEnabledFlag": {
"description": "Flag indicates if the alerts and notifications are enabled on the email.",
"type": "boolean",
"example": true
},
"digitalChannelEnrollmentFlag": {
"description": "Flag indicates if the email uses or linked to any Digital Banking service. Ex- BNE, etc.",
"type": "boolean",
"example": true
},
"cubAlertEnabledFlag": {
"description": "Indicates if the email is registered to CUB (anti identity theft prevention) alerts and notifications",
"type": "boolean",
"example": true
},
"cubProcessFlag": {
"description": "Indicates if the CUB process or flow is to be followed to retrieve the email data or the normal flow",
"type": "boolean",
"example": true
},
"agent": {
"$ref": "#/definitions/AgentDetail"
}
},
"required": [
"applicationId"
]
}
{
"type": "object",
"properties": {
"agentId": {
"description": "Agent payroll id or soeid.",
"type": "string",
"example": "hg12345"
},
"branchId": {
"description": "Unique identifier of the office or branch of the agent.",
"type": "string",
"example": "0123"
}
}
}
{
"type": "object",
"properties": {
"dataCenterLocation": {
"description": "CSI Data center location number",
"type": "string",
"example": "12"
},
"registrationDate": {
"description": "Registration Date of Email",
"type": "string",
"format": "date",
"example": "2019-06-12"
},
"messageText": {
"description": "Text message for the addition/modification",
"type": "string",
"example": "Record added successfully"
},
"errorMessage": {
"description": "Text message for the error response",
"type": "string",
"example": "Record not found"
}
}
}
{
"type": "object",
"properties": {
"customerId": {
"description": "Unique identifier of the customer",
"type": "string",
"example": "123456789012"
},
"agentId": {
"description": "Executive Number of the agent who is creating/updating the records",
"type": "string",
"example": "000001494120"
},
"lineOfBusinessCode": {
"description": "Origin from where the phone was created (CAT, Cash)",
"type": "string",
"example": "0005"
},
"productCode": {
"description": "Product Code",
"type": "string",
"example": "0066"
},
"productInstrument": {
"description": "Product Instrument",
"type": "string",
"example": "06"
},
"security": {
"$ref": "#/definitions/Security"
},
"phone": {
"$ref": "#/definitions/PhoneInformation"
}
},
"required": [
"customerId"
]
}
{
"type": "object",
"properties": {
"cofetelIndex": {
"description": "Cofetel Index",
"type": "string",
"example": "12"
},
"extensionNumber": {
"description": "Phone Extension Number",
"type": "string",
"example": "87654"
},
"lastCallDate": {
"description": "Date Of last phone call made",
"type": "string",
"format": "date",
"example": "2019-06-22"
},
"lastFailedContactDate": {
"description": "last call date",
"type": "string",
"format": "date",
"example": "2019-12-22"
},
"lastUpdatedDate": {
"description": "Modification date of the record",
"type": "string",
"format": "date",
"example": "2019-12-26"
},
"phoneCountryCode": {
"description": "country code of the phone",
"type": "string",
"example": "52"
},
"phoneNumber": {
"description": "Phone number of the customer",
"type": "string",
"example": "5544332211"
},
"phoneOwnershipIndicator": {
"description": "If the phone belongs to the customer or not",
"type": "string",
"example": "1906"
},
"phoneStatus": {
"description": "Phone status",
"type": "string",
"example": "11"
},
"phoneType": {
"description": "Type of phone",
"type": "string",
"example": "02"
},
"phoneTypeDescription": {
"description": "Description of type of phone",
"type": "string",
"example": "Home"
},
"subAreaCode": {
"description": "Sub area of the phone information",
"type": "string",
"example": "10000003"
},
"updatedAreaCode": {
"description": "Updated area code",
"type": "string",
"example": "0003"
},
"certificationType": {
"description": "Type of phone certification. Level 1, Level 2, Level 3",
"type": "string",
"example": "004"
},
"certificationRejectedCount": {
"description": "Number of times the certification of phone has been declined or rejected",
"type": "integer",
"example": 5
},
"certificationAppliedType": {
"description": "Way in which certification is applied to the customer",
"type": "string",
"example": "4"
},
"certificationCampaignId": {
"description": "Mobile phone-certified campaign number",
"type": "string",
"example": "00000004"
},
"lastActivityDate": {
"description": "Date of last access of the user to banking",
"type": "string",
"format": "date",
"example": "2019-09-27"
},
"phoneAdditionalInformation": {
"$ref": "#/definitions/PhoneAdditionalInformation"
}
},
"required": [
"phoneNumber"
]
}
{
"type": "object",
"properties": {
"channelCode": {
"description": "Phone Media. Telephone registration or modification channel.",
"type": "string",
"example": "01"
},
"originDepartmentId": {
"description": "Key of the department of origin of the phone. Ex- Billing, Clarifications, etc.",
"type": "string",
"example": "0123"
},
"departmentId": {
"description": "Department or area that adds or modifies the telephone data",
"type": "string",
"example": "0123"
},
"originCountryCode": {
"description": "Country of origin of the mobile carrier of the phone",
"type": "string",
"example": "01"
},
"phoneNumberPreferenceType": {
"description": "Refers to the type of the preference of the phone. Ex- Home, Office, Messages, etc.",
"type": "string",
"example": "0123"
},
"applicationSource": {
"description": "Process by which the phone was captured or updated. Example- branch, Fraud etc.",
"type": "string",
"example": "01"
},
"channelPriority": {
"description": "The channel with the highest priority that captured the phone.",
"type": "string",
"example": "01"
},
"applicationId": {
"description": "Front application that captured or updated the phone. Ex- OneEclipse etc.",
"type": "string",
"example": "0123"
},
"authenticationMethodCode": {
"description": "The method used for authentication of this telephone when it is last added or modified. Ex- OTP, ATM etc.",
"type": "string",
"example": "01"
},
"primaryAuthenticationMethodCode": {
"description": "The method used for authentication of this telephone when it was added the first time. Ex- OTP, ATM etc.",
"type": "string",
"example": "01"
},
"declineAuthenticationCode": {
"description": "This is the reason code for why the phone was not verified",
"type": "string",
"example": "01"
},
"phoneAuthenticationDate": {
"description": "Phone verification date",
"type": "string",
"format": "date",
"example": "2019-09-22"
},
"phoneRestrictedCode": {
"description": "The code that tells the restrictions on the phone, if any. Ex- if it is blacklisted, REUS, Article 44.",
"type": "string",
"example": "0123"
},
"alertEnabledFlag": {
"description": "Flag indicates if the alerts and notifications are enabled on the phone.",
"type": "boolean",
"example": true
},
"digitalChannelEnrollmentFlag": {
"description": "Flag indicates if the phone uses any Digital Banking service. Ex- BNE, etc.",
"type": "boolean",
"example": true
},
"cubAlertEnabledFlag": {
"description": "Indicates if the phone is registered to CUB (anti identity theft prevention) alerts and notifications",
"type": "boolean",
"example": true
},
"cubProcessFlag": {
"description": "Indicates if the CUB process or flow is to be followed to retrieve the phone data or the normal flow",
"type": "boolean",
"example": true
},
"preferredCallTime": {
"description": "Preferred time to call",
"type": "string",
"example": "14:00:00"
},
"accountNumber": {
"description": "Account number to which the phone is related.",
"type": "string",
"example": "1234567890123456"
},
"deregistrationDate": {
"description": "Deregistration date of Phone",
"type": "string",
"format": "date",
"example": "2020-02-02",
"maxLength": 10
},
"branchId": {
"description": "Unique identifier of the office or branch of the agent.",
"type": "string",
"example": "0123"
}
},
"required": [
"applicationId"
]
}
{
"type": "object",
"properties": {
"lastUpdatedDate": {
"description": "Modification date",
"type": "string",
"format": "date",
"example": "2019-12-26"
},
"messageText": {
"description": "Text message for the addition/modification",
"type": "string",
"example": "Record added successfully"
},
"registrationDate": {
"description": "creation Date",
"type": "string",
"format": "date",
"example": "2019-12-26"
}
}
}
{
"type": "object",
"properties": {
"customerId": {
"description": "Unique identifier of the customer",
"type": "string",
"example": "123456789012"
},
"emailInformation": {
"$ref": "#/definitions/EmailInformation"
},
"security": {
"$ref": "#/definitions/SecurityDetail"
}
},
"required": [
"customerId",
"security"
]
}
{
"type": "object",
"properties": {
"emailAddress": {
"description": "Email Address",
"type": "string",
"example": "algo@algo.com"
},
"emailSequenceNumber": {
"description": "Sequence number of the electronic address",
"type": "integer",
"format": "int32",
"example": 1234
},
"channelType": {
"description": "To indicate what type of channel used for communication with involved party. Ex- email, fax etc.",
"type": "string",
"example": "02",
"maxLength": 2
},
"emailUsageCount": {
"description": "Usage number of the electronic address",
"type": "integer",
"format": "int32",
"example": 1234
},
"serviceProvider": {
"description": "This is the provider of the services like yahoo, Hotmail, gmail, etc.",
"type": "string",
"example": "0000"
},
"emailAdditionalInformation": {
"$ref": "#/definitions/EmailAdditionalInformation"
}
},
"required": [
"emailAddress"
]
}
{
"type": "object",
"properties": {
"channelCode": {
"description": "Email Media. Email registration or modification channel.",
"type": "string",
"example": "01"
},
"departmentId": {
"description": "Department or area that adds or modifies the email data",
"type": "string",
"example": "0123"
},
"applicationSource": {
"description": "Process by which the email was captured or updated. Example- branch, Fraud etc.",
"type": "string",
"example": "01"
},
"channelPriority": {
"description": "The channel with the highest priority that captured the email.",
"type": "string",
"example": "01"
},
"applicationId": {
"description": "Front application that captured or updated the email. Ex- OneEclipse etc.",
"type": "string",
"example": "0123"
},
"authenticationMethodCode": {
"description": "The method used for authentication of this email when it is last added or modified. Ex- OTP, ATM etc.",
"type": "string",
"example": "01"
},
"primaryAuthenticationMethodCode": {
"description": "The method used for authentication of this email when it was added the first time. Ex- OTP, ATM etc.",
"type": "string",
"example": "01"
},
"declineAuthenticationCode": {
"description": "This is the reason code for why the email was not verified",
"type": "string",
"example": "01"
},
"emailAuthenticationDate": {
"description": "The date of the email verification.",
"type": "string",
"format": "date",
"example": "2020-03-11"
},
"emailStatus": {
"description": "Status of the email.",
"type": "string",
"example": "01"
},
"emailType": {
"description": "Category of the electronic address. Like Personal, office etc.",
"type": "string",
"example": "02"
},
"emailRestrictedCode": {
"description": "The code that tells the restrictions on the email, if any. Ex- if it is blacklisted, REUS, Article 44.",
"type": "string",
"example": "0123"
},
"lastContactedDate": {
"description": "Date Of last successful email contact made to the customer",
"type": "string",
"format": "date",
"example": "2020-03-12"
},
"alertEnabledFlag": {
"description": "Flag indicates if the alerts and notifications are enabled on the email.",
"type": "boolean",
"example": true
},
"digitalChannelEnrollmentFlag": {
"description": "Flag indicates if the email uses or linked to any Digital Banking service. Ex- BNE, etc.",
"type": "boolean",
"example": true
},
"cubAlertEnabledFlag": {
"description": "Indicates if the email is registered to CUB (anti identity theft prevention) alerts and notifications",
"type": "boolean",
"example": true
},
"cubProcessFlag": {
"description": "Indicates if the CUB process or flow is to be followed to retrieve the email data or the normal flow",
"type": "boolean",
"example": true
},
"agent": {
"$ref": "#/definitions/AgentInformation"
}
},
"required": [
"applicationId"
]
}
{
"type": "object",
"properties": {
"agentId": {
"description": "Agent payroll id or soeid.",
"type": "string",
"example": "hg12345"
},
"branchId": {
"description": "Unique identifier of the office or branch of the agent.",
"type": "string",
"example": "0123"
}
}
}
{
"type": "object",
"properties": {
"dataCenterLocation": {
"description": "CSI Data center location number",
"type": "string",
"example": "12"
},
"lastUpdatedDate": {
"description": "Last updated Date of Email",
"type": "string",
"format": "date",
"example": "2019-06-22"
},
"registrationDate": {
"description": "Registration Date of Email",
"type": "string",
"format": "date",
"example": "2019-06-12"
},
"messageText": {
"description": "Text message for the addition/modification",
"type": "string",
"example": "Record added successfully"
},
"errorMessage": {
"description": "Text message for the error response",
"type": "string",
"example": "Record not found"
}
}
}
{
"type": "object",
"properties": {
"customerId": {
"description": "Unique identifier of the customer",
"type": "string",
"example": "123456789012"
},
"cubProcessFlag": {
"description": "Indicates if the CUB process or flow is to be followed to retrieve the phone/email data or the normal flow",
"type": "boolean",
"example": true
},
"applicationSource": {
"description": "Process by which the phone/email was captured or updated. Example- branch, Fraud etc.",
"type": "string",
"example": "01"
},
"channelPriority": {
"description": "The channel with the highest priority that captured the phone/email.",
"type": "string",
"example": "01"
},
"applicationId": {
"description": "Front application that captured or updated the phone/email. Ex- OneEclipse etc.",
"type": "string",
"example": "0123"
}
},
"required": [
"customerId",
"applicationId"
]
}
{
"type": "object",
"properties": {
"emailRecordDetail": {
"$ref": "#/definitions/EmailRecordDetail"
},
"phoneRecordDetail": {
"$ref": "#/definitions/PhoneRecordDetail"
}
}
}
{
"type": "object",
"properties": {
"errorMessage": {
"description": "Error description from the backend",
"type": "string",
"example": "Default Error message"
},
"customer": {
"$ref": "#/definitions/Customer"
}
}
}
{
"type": "object",
"properties": {
"customerId": {
"description": "Unique identifier of the customer",
"type": "string",
"example": "123456789012"
},
"phone": {
"type": "array",
"items": {
"$ref": "#/definitions/Phone"
}
}
},
"required": [
"customerId"
]
}
{
"type": "object",
"properties": {
"phoneType": {
"description": "phoneType",
"type": "string",
"example": "01",
"maxLength": 2
},
"cofetelIndex": {
"description": "cofetelIndex",
"type": "string",
"example": "0000",
"maxLength": 4
},
"phoneNumber": {
"description": "phoneNumber",
"type": "string",
"example": "3323479817",
"maxLength": 10
},
"extensionNumber": {
"description": "extensionNumber",
"type": "string",
"example": "0000000",
"maxLength": 8
},
"registrationDate": {
"description": "phoneRegistrationDate",
"type": "string",
"format": "date",
"example": "2018-02-02",
"maxLength": 10
},
"lastUpdatedDate": {
"description": "lastUpdatedDate",
"type": "string",
"format": "date",
"example": "2018-02-02",
"maxLength": 10
},
"lastFailedContactDate": {
"description": "last call date",
"type": "string",
"format": "date",
"example": "2018-02-02",
"maxLength": 10
},
"lastCorrespondenceDate": {
"description": "last customer contact by call",
"type": "string",
"format": "date",
"example": "2018-02-02",
"maxLength": 10
},
"phoneStatus": {
"description": "phoneStatus",
"type": "string",
"example": "20180202",
"maxLength": 8
},
"serviceProviderId": {
"description": "Service provider Id",
"type": "string",
"example": "0000",
"maxLength": 4
},
"agentId": {
"description": "Id of bank executive",
"type": "string",
"example": "000000000000",
"maxLength": 12
},
"phoneCountryCode": {
"description": "country code of the phone",
"type": "string",
"example": "52"
},
"bankInternalSubAreaUpdated": {
"description": "bankInternalSubAreaUpdated",
"type": "string",
"example": "00000000",
"maxLength": 8
},
"phoneAdditionalInfo": {
"$ref": "#/definitions/PhoneAdditionalInfo"
},
"phoneBasedFirstAccount": {
"$ref": "#/definitions/PhoneBasedFirstAccountInfo"
}
}
}
{
"type": "object",
"properties": {
"accountNumber": {
"description": "accountNumber",
"type": "string",
"example": "000000000000",
"maxLength": 12
},
"productCode": {
"description": "productCode",
"type": "string",
"example": "0000",
"maxLength": 4
},
"productInstrument": {
"description": "productInstrument",
"type": "string",
"example": "00",
"maxLength": 2
},
"accountPrefix": {
"description": "accountPrefix",
"type": "string",
"example": "0000",
"maxLength": 4
}
}
}
{
"type": "object",
"properties": {
"deregistrationDate": {
"description": "phone cancel date",
"type": "string",
"format": "date",
"example": "2018-02-02",
"maxLength": 10
},
"channelCode": {
"description": "Phone Media. Telephone registration or modification channel.",
"type": "string",
"example": "01"
},
"originDepartmentId": {
"description": "Key of the department of origin of the phone. Ex- Billing, Clarifications, etc.",
"type": "string",
"example": "0123"
},
"departmentId": {
"description": "Department or area that adds or modifies the telephone data",
"type": "string",
"example": "0123"
},
"originCountryCode": {
"description": "Country of origin of the mobile carrier of the phone",
"type": "string",
"example": "01"
},
"phoneNumberPreferenceType": {
"description": "Refers to the type of the preference of the phone. Ex- Home, Office, Messages, etc.",
"type": "string",
"example": "0123"
},
"applicationSource": {
"description": "Process by which the phone was captured or updated. Example- branch, Fraud etc.",
"type": "string",
"example": "01"
},
"channelPriority": {
"description": "The channel with the highest priority that captured the phone.",
"type": "string",
"example": "01"
},
"applicationId": {
"description": "Front application that captured or updated the phone. Ex- OneEclipse etc.",
"type": "string",
"example": "0123"
},
"authenticationMethodCode": {
"description": "The method used for authentication of this telephone when it is last added or modified. Ex- OTP, ATM etc.",
"type": "string",
"example": "01"
},
"primaryAuthenticationMethodCode": {
"description": "The method used for authentication of this telephone when it was added the first time. Ex- OTP, ATM etc.",
"type": "string",
"example": "01"
},
"declineAuthenticationCode": {
"description": "This is the reason code for why the phone was not verified",
"type": "string",
"example": "01"
},
"phoneAuthenticationDate": {
"description": "Phone verification date",
"type": "string",
"format": "date",
"example": "2019-09-22"
},
"phoneRestrictedCode": {
"description": "The code that tells the restrictions on the phone, if any. Ex- if it is blacklisted, REUS, Article 44.",
"type": "string",
"example": "0123"
},
"alertEnabledFlag": {
"description": "Flag indicates if the alerts and notifications are enabled on the phone.",
"type": "boolean",
"example": true
},
"digitalChannelEnrollmentFlag": {
"description": "Flag indicates if the phone uses any Digital Banking service. Ex- BNE, etc.",
"type": "boolean",
"example": true
},
"cubAlertEnabledFlag": {
"description": "Indicates if the phone is registered to CUB (anti identity theft prevention) alerts and notifications",
"type": "boolean",
"example": true
},
"cubProcessFlag": {
"description": "Indicates if the CUB process or flow is to be followed to retrieve the phone data or the normal flow",
"type": "boolean",
"example": true
},
"preferredCallTime": {
"description": "Preferred time to call",
"type": "string",
"example": "14:00:00"
},
"accountNumber": {
"description": "Account number to which the phone is related.",
"type": "string",
"example": "1234567890123456"
},
"branchId": {
"description": "Unique identifier of the office or branch of the agent.",
"type": "string",
"example": "0123"
}
},
"required": [
"applicationId"
]
}
{
"type": "object",
"properties": {
"dataCenterLocation": {
"description": "CSI",
"type": "string",
"example": "10",
"maxLength": 2
},
"errorMessage": {
"description": "Error description from the backend",
"type": "string",
"example": "Default Error message"
},
"customer": {
"$ref": "#/definitions/CustomerInfo"
}
}
}
{
"type": "object",
"properties": {
"customerId": {
"description": "Unique identifier of the customer",
"type": "string",
"example": "123456789012"
},
"emailInfo": {
"type": "array",
"items": {
"$ref": "#/definitions/EmailInfo"
}
}
},
"required": [
"customerId"
]
}
{
"type": "object",
"properties": {
"emailAddress": {
"description": "emailAddress",
"type": "string",
"example": "algo@algo.com",
"maxLength": 78
},
"channelType": {
"description": "To indicate what type of channel used for communication with involved party. Ex- email, fax etc.",
"type": "string",
"example": "02",
"maxLength": 2
},
"emailSequenceNumber": {
"description": "Sequence number of the electronic address",
"type": "integer",
"example": 1234,
"maxLength": 4
},
"emailUsageCount": {
"description": "Usage number of the electronic address",
"type": "integer",
"example": 1234,
"maxLength": 4
},
"serviceProvider": {
"description": "serviceProvider",
"type": "string",
"example": "0000",
"maxLength": 4
},
"lastUpdatedDate": {
"description": "lastUpdateDate",
"type": "string",
"format": "date",
"example": "2015-01-01",
"maxLength": 10
},
"registrationDate": {
"description": "registrationDate",
"type": "string",
"format": "date",
"example": "2015-01-01",
"maxLength": 10
},
"emailAdditionalInfo": {
"$ref": "#/definitions/EmailAdditionalInfo"
}
}
}
{
"type": "object",
"properties": {
"channelCode": {
"description": "Email Media. Email registration or modification channel.",
"type": "string",
"example": "01"
},
"departmentId": {
"description": "Department or area that adds or modifies the email data",
"type": "string",
"example": "0123"
},
"applicationSource": {
"description": "Process by which the email was captured or updated. Example- branch, Fraud etc.",
"type": "string",
"example": "01"
},
"channelPriority": {
"description": "The channel with the highest priority that captured the email.",
"type": "string",
"example": "01"
},
"applicationId": {
"description": "Front application that captured or updated the email. Ex- OneEclipse etc.",
"type": "string",
"example": "0123"
},
"authenticationMethodCode": {
"description": "The method used for authentication of this email when it is last added or modified. Ex- OTP, ATM etc.",
"type": "string",
"example": "01"
},
"primaryAuthenticationMethodCode": {
"description": "The method used for authentication of this email when it was added the first time. Ex- OTP, ATM etc.",
"type": "string",
"example": "01"
},
"declineAuthenticationCode": {
"description": "This is the reason code for why the email was not verified",
"type": "string",
"example": "01"
},
"emailAuthenticationDate": {
"description": "The date of the email verification.",
"type": "string",
"format": "date",
"example": "2020-03-11"
},
"emailStatus": {
"description": "Status of the email.",
"type": "string",
"example": "01"
},
"emailType": {
"description": "Category of the electronic address. Like Personal, office etc.",
"type": "string",
"example": "02"
},
"emailRestrictedCode": {
"description": "The code that tells the restrictions on the email, if any. Ex- if it is blacklisted, REUS, Article 44.",
"type": "string",
"example": "0123"
},
"lastContactedDate": {
"description": "Date Of last successful email contact made to the customer",
"type": "string",
"format": "date",
"example": "2020-03-12"
},
"alertEnabledFlag": {
"description": "Flag indicates if the alerts and notifications are enabled on the email.",
"type": "boolean",
"example": true
},
"digitalChannelEnrollmentFlag": {
"description": "Flag indicates if the email uses or linked to any Digital Banking service. Ex- BNE, etc.",
"type": "boolean",
"example": true
},
"cubAlertEnabledFlag": {
"description": "Indicates if the email is registered to CUB (anti identity theft prevention) alerts and notifications",
"type": "boolean",
"example": true
},
"cubProcessFlag": {
"description": "Indicates if the CUB process or flow is to be followed to retrieve the email data or the normal flow",
"type": "boolean",
"example": true
},
"agent": {
"$ref": "#/definitions/AgentDE"
}
},
"required": [
"applicationId"
]
}
{
"type": "object",
"properties": {
"agentId": {
"description": "Agent payroll id or soeid.",
"type": "string",
"example": "hg12345"
},
"branchId": {
"description": "Unique identifier of the office or branch of the agent.",
"type": "string",
"example": "0123"
}
}
}
{
"properties": {
"type": {
"type": "string",
"description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
"enum": [
"error",
"warn",
"invalid",
"fatal"
]
},
"code": {
"description": "Error code which qualifies the error",
"type": "string"
},
"details": {
"description": "Human readable explanation specific to the occurrence of the problem",
"type": "string"
},
"location": {
"description": "The name of the field that resulted in the error",
"type": "string"
},
"moreInfo": {
"description": "URI to human readable documentation or detailed description of the error",
"type": "string"
},
"uuid": {
"description": "128 bit UUID that you generate for every request",
"type": "string"
},
"timestamp": {
"description": "Timestamp of the error",
"type": "string"
}
},
"required": [
"type",
"code"
]
}