--- swagger: "2.0" info: version: 1.1.0 title: CSMT-CRD-D-CustomerContactProfileDetail description: This microservice will retreive data for individual and corporate customers x-ibm-name: csmt-crd-d-customercontactprofiledetail host: 127.0.0.1 basePath: /api schemes: - https produces: - application/json paths: /v1/customers/profile/contact/retrieve: post: tags: - retrieve-customer-contact-record operationId: retrieve-customer-contact-record summary: API to retrieve the contact record for the customer description: This api is used to retrieve the contact record for the customer consumes: - application/json produces: - application/json parameters: - name: client_id in: header required: false type: string description: Client ID generated during application registration - name: Authorization in: header description: The Authorization Token received during login type: string required: false - name: Accept in: header description: Content-Types that are acceptable for the response type: string required: true - name: uuid in: header description: 128 bit UUID that you generate for every request type: string required: true - name: Accept-Language in: header description: List of acceptable human languages for response type: string required: false - name: Content-Type in: header description: Content-Types that are sent in the request required: true type: string - name: channelId in: header description: channel where request originated type: string required: true - name: countryCode in: header required: true type: string description: Country code in 2 character ISO 3166 format - name: businessCode in: header required: true type: string description: Business code identified during application registration - name: sid in: header required: false type: string description: SessionId sent by Consumer - name: retrieveCustomerContactRequest in: body schema: $ref: '#/definitions/RetrieveCustomerContactRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/RetrieveCustomerContactResponse' 400: description:
TypeCodeDetails
errorinvalidRequestMissing or invalid Parameters
schema: $ref: '#/definitions/ErrorResponse' 401: description:
TypeCodeDetails
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
TypeCodeDetailsMore Info
erroraccessNotConfiguredThe request operation is not configured to access this resourceChannel/Country/Business provided in the request is not supported currently
schema: $ref: '#/definitions/ErrorResponse' 404: description:
TypeCodeDetailsMore Info
errorresourceNotFoundThe requested resource was not foundEmpty resource/resource not found
schema: $ref: '#/definitions/ErrorResponse' 422: description:
TypeCodeDetails
errorbusinessValidationFailedBusiness validation error occured on one or more parameters
schema: $ref: '#/definitions/ErrorResponse' 500: description:
TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error/server unavailability
schema: $ref: '#/definitions/ErrorResponse' definitions: RetrieveCustomerContactRequest: type: object properties: customerId: description: Unique identifier of the customer type: string example: "123456789012" required: - customerId RetrieveCustomerContactResponse: type: object properties: bestEmailRecordInformation: $ref: '#/definitions/BestEmailRecordInformation' bestPhoneRecordInformation: $ref: '#/definitions/BestPhoneRecordInformation' bestAddressRecordInformation: $ref: '#/definitions/BestAddressRecordInformation' BestPhoneRecordInformation: type: object properties: errorMessage: description: Error description from the backend type: string example: Default Error message phoneData: type: array items: $ref: '#/definitions/PhoneData' PhoneData: 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 deregistrationDate: description: phone cancel date type: string format: date example: "2018-02-02" maxLength: 10 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 countryCode: description: countryCode type: string example: "" bankInternalAreaUpdated: description: bankInternalAreaUpdated type: string example: "0000" maxLength: 4 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: employeeId type: string example: "000000000000" maxLength: 12 phoneOwnershipIndicator: description: is the phone belongs to the customer or not type: string example: "0000" maxLength: 4 bankInternalSubAreaUpdated: description: bankInternalSubAreaUpdated type: string example: "00000000" maxLength: 8 phoneSource: description: phoneSource type: string example: "0000" maxLength: 4 preferContactMedium: description: preferContactMedium type: string example: "00" maxLength: 2 phoneBasedFirstAccount: $ref: '#/definitions/PhoneBasedFirstAccount' PhoneBasedFirstAccount: 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 BestEmailRecordInformation: type: object properties: errorMessage: description: Error description from the backend type: string example: Default Error message email: type: array items: $ref: '#/definitions/Email' Email: type: object properties: emailAddress: description: emailAddress type: string example: algo@algo.com maxLength: 78 emailSequenceNumber: description: Sequence number of the electronic address type: integer format: int32 example: 1234 emailUsageCount: description: Usage number of the electronic address type: integer format: int32 example: 1234 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 required: - emailSequenceNumber - emailAddress BestAddressRecordInformation: type: object properties: customerName: description: customerName type: string example: "" errorMessage: description: Error description from the backend type: string example: Default Error message addressDataDetail: type: array items: $ref: '#/definitions/AddressDataDetail' required: - customerName AddressDataDetail: type: object properties: addressId: description: address identifier type: string example: "1234" maxLength: 4 addressType: description: Identifies the type of address-commercial, home, etc. type: string example: "12" maxLength: 2 residencyStatus: description: Status of current residence whether house is owned or rented type: string example: "12" maxLength: 2 addressUsageCount: description: addressUsageCount type: integer format: int32 example: 2 maxLength: 4 streetName: description: StreetName type: string example: GRUPO BANAMEX 4945914 maxLength: 36 colony: description: colony type: string example: 'EX HACIENDA DE COAPA ' maxLength: 24 state: description: StateName type: string example: TLALPAN maxLength: 20 stateCode: description: stateCode type: string example: "" postalCode: description: postalCode type: string example: "01" maxLength: 2 addressStatus: description: addressStatus type: string example: 099999 maxLength: 2 registrationDate: description: registrationDate type: string format: date example: "2015-01-01" maxLength: 10 countryCode: description: countryCode type: string example: "0003" maxLength: 4 lastUpdatedDate: description: lastUpdatedDate type: string format: date example: "2015-01-01" maxLength: 10 RetrieveCustomerPhoneRequest: 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 data or the normal flow type: boolean example: true applicationSource: description: Process by which the phone was captured or updated. Example- branch, Fraud etc. type: string maxLength: 2 example: "01" channelPriority: description: The channel with the highest priority that captured the phone. type: string maxLength: 2 example: "01" applicationId: description: Front application that captured or updated the phone. Ex- OneEclipse etc. type: string maxLength: 4 example: "0123" sourceSystem: description: It is an identifier for each Front and serves to know where the transaction is made type: string example: "003456" employeeId: description: It is an identifier for the executive payroll (this data is sent by the front) type: string example: 0001494120 required: - customerId - cubProcessFlag - applicationSource - channelPriority - applicationId - sourceSystem - employeeId RetrieveCustomerPhoneResponse: type: object properties: errorMessage: description: Error description from the backend type: string example: Default Error message customer: $ref: '#/definitions/Customer' Customer: type: object properties: customerId: description: Unique identifier of the customer type: string example: "123456789012" phone: type: array items: $ref: '#/definitions/PhoneInfo' required: - customerId PhoneInfo: 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" bankInternalAreaUpdated: description: bankInternalAreaUpdated type: string example: "0000" maxLength: 4 deregistrationDate: description: phone cancel date type: string format: date example: "2018-02-02" maxLength: 10 preferContactMedium: description: preferContactMedium type: string example: "00" maxLength: 2 phoneSource: description: phoneSource type: string example: "0000" maxLength: 4 phoneOwnershipIndicator: description: If the phone belongs to the customer or not type: string example: "1906" bankInternalSubAreaUpdated: description: bankInternalSubAreaUpdated type: string example: "00000000" maxLength: 8 riskAlertEnabledFlag: description: Indicates if customer should be contacted or not if a risk is identified type: boolean example: true phoneAdditionalInfo: $ref: '#/definitions/PhoneAdditionalInfo' phoneBasedFirstAccount: $ref: '#/definitions/PhoneBasedFirstAccountInfo' 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 PhoneAdditionalInfo: type: object properties: applicationSource: description: Process by which the phone was captured or updated. Example- branch, Fraud etc. type: string maxLength: 2 example: "01" channelPriority: description: The channel with the highest priority that captured the phone. type: string maxLength: 2 example: "01" applicationId: description: Front application that captured or updated the phone. Ex- OneEclipse etc. type: string maxLength: 4 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: - applicationSource - applicationId - channelPriority RetrieveCustomerEmailRequest: 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 email data or the normal flow type: boolean example: true applicationSource: description: Process by which the email was captured or updated. Example- branch, Fraud etc. type: string maxLength: 2 example: "01" channelPriority: description: The channel with the highest priority that captured the email. type: string maxLength: 2 example: "01" applicationId: description: Front application that captured or updated the email. Ex- OneEclipse etc. type: string maxLength: 4 example: "0123" sourceSystem: description: It is an identifier for each Front and serves to know where the transaction is made type: string example: "003456" employeeId: description: It is an identifier for the executive payroll (this data is sent by the front) type: string example: 0001494120 required: - customerId - cubProcessFlag - applicationSource - channelPriority - applicationId - sourceSystem - employeeId RetrieveCustomerEmailResponse: type: object properties: errorMessage: description: Error description from the backend type: string example: Default Error message customer: $ref: '#/definitions/CustomerInfo' CustomerInfo: type: object properties: customerId: description: Unique identifier of the customer type: string example: "123456789012" emailInfo: type: array items: $ref: '#/definitions/EmailInfo' required: - customerId EmailInfo: type: object properties: emailAddress: description: emailAddress type: string example: algo@algo.com maxLength: 78 emailSequenceNumber: description: Sequence number of the electronic address type: integer format: int32 example: 1234 emailUsageCount: description: Usage number of the electronic address type: integer format: int32 example: 1234 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 emailType: description: Category of the electronic address. Like Personal, office etc. type: string example: "02" riskAlertEnabledFlag: description: Indicates if customer should be contacted or not if a risk is identified type: boolean example: true emailAdditionalInfo: $ref: '#/definitions/EmailAdditionalInfo' required: - emailType - emailSequenceNumber - emailAddress EmailAdditionalInfo: type: object properties: verificationType: description: Certification level type type: integer format: int32 example: 1 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 maxLength: 2 example: "01" channelPriority: description: The channel with the highest priority that captured the email. type: string maxLength: 2 example: "01" applicationId: description: Front application that captured or updated the email. Ex- OneEclipse etc. type: string maxLength: 4 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: - applicationSource - applicationId - channelPriority - emailType AgentDE: 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" CreateCustomerPhoneRequest: 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" 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 sourceSystem: description: It is an identifier for each Front and serves to know where the transaction is made type: string example: "003456" employeeId: description: It is an identifier for the executive payroll (this data is sent by the front) type: string example: 0001494120 phone: $ref: '#/definitions/PhoneDE' required: - customerId - sourceSystem - employeeId - cubProcessFlag PhoneDE: type: object properties: cofetelIndex: description: Cofetel Index type: string example: "12" extensionNumber: description: Phone Extension Number type: string example: "87654" phoneCountryCode: description: country code of the phone type: string example: "52" phoneNumber: description: Phone number of the customer type: string example: "5544332211" prefixLineNumber: description: First 3 or 6 digits of phone number other than country code, area code. type: string maxLength: 6 example: "044" 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" countryCode: description: countryCode type: string example: "" bankInternalAreaUpdated: description: bankInternalAreaUpdated type: string example: "0000" maxLength: 4 serviceProviderId: description: Service provider Id type: string example: "0000" maxLength: 4 bankInternalSubAreaUpdated: description: bankInternalSubAreaUpdated type: string example: "00000000" maxLength: 8 phoneSource: description: phoneSource type: string example: "0000" maxLength: 4 riskAlertEnabledFlag: description: Indicates if customer should be contacted or not if a risk is identified type: boolean example: true phoneAdditionalDetail: $ref: '#/definitions/PhoneAdditionalDetail' required: - phoneNumber - bankInternalSubAreaUpdated - riskAlertEnabledFlag PhoneAdditionalDetail: type: object properties: channelCode: description: Phone Media. Telephone registration or modification channel. type: string example: "01" accountNumber: description: Account number to which the phone is related. type: string example: "1234567890123456" accountPrefix: description: accountPrefix type: string example: "0000" maxLength: 4 applicationSource: description: Process by which the phone was captured or updated. Example- branch, Fraud etc. type: string maxLength: 2 example: "01" channelPriority: description: The channel with the highest priority that captured the phone. type: string maxLength: 2 example: "01" 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" applicationId: description: Front application that captured or updated the phone. Ex- OneEclipse etc. type: string maxLength: 4 example: "0123" branchId: description: Unique identifier of the office or branch of the agent. type: string example: "0123" 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" 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" preferredCallTime: description: Preferred time to call type: string example: "14:00:00" 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 required: - applicationSource - channelPriority - applicationId CreateCustomerPhoneResponse: type: object properties: messageText: description: Text message for the addition/modification type: string example: Record added successfully registrationDate: description: Registration Date of Email type: string format: date example: "2019-06-12" required: - messageText - registrationDate CreateCustomerEmailRequest: 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 email data or the normal flow type: boolean example: true sourceSystem: description: It is an identifier for each Front and serves to know where the transaction is made type: string example: "003456" employeeId: description: It is an identifier for the executive payroll (this data is sent by the front) type: string example: 0001494120 email: $ref: '#/definitions/EmailDE' required: - customerId - sourceSystem - employeeId - cubProcessFlag EmailDE: type: object properties: emailAddress: description: Email Address type: string example: algo@algo.com serviceProvider: description: This is the provider of the services like yahoo, Hotmail, gmail, etc. type: string example: "0000" riskAlertEnabledFlag: description: Indicates if customer should be contacted or not if a risk is identified type: boolean example: true emailAdditionalDetail: $ref: '#/definitions/EmailAdditionalDetail' required: - emailAddress - riskAlertEnabledFlag EmailAdditionalDetail: type: object properties: emailType: description: Category of the electronic address. Like Personal, office etc. type: string example: "02" channelCode: description: Email Media. Email registration or modification channel. type: string example: "01" applicationSource: description: Process by which the email was captured or updated. Example- branch, Fraud etc. type: string maxLength: 2 example: "01" departmentId: description: Department or area that adds or modifies the email data type: string example: "0123" channelPriority: description: The channel with the highest priority that captured the email. type: string maxLength: 2 example: "01" 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" applicationId: description: Front application that captured or updated the email. Ex- OneEclipse etc. type: string maxLength: 4 example: "0123" 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" 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" verificationType: description: Certification level type type: integer format: int32 example: 1 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 agent: $ref: '#/definitions/AgentDetail' required: - applicationSource - channelPriority - applicationId - emailStatus - verificationType AgentDetail: 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" CreateCustomerEmailResponse: type: object properties: errorMessage: description: Text message for the error response type: string example: Record not found registrationDate: description: creation Date type: string format: date example: "2019-12-26" messageText: description: Text message for the addition/modification type: string example: Record added successfully required: - messageText - registrationDate UpdateCustomerPhoneRequest: 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" 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 sourceSystem: description: It is an identifier for each Front and serves to know where the transaction is made type: string example: "003456" employeeId: description: It is an identifier for the executive payroll (this data is sent by the front) type: string example: 0001494120 phone: $ref: '#/definitions/PhoneInformation' required: - customerId - sourceSystem - employeeId - cubProcessFlag PhoneInformation: type: object properties: cofetelIndex: description: Cofetel Index type: string example: "12" extensionNumber: description: Phone Extension Number type: string example: "87654" phoneCountryCode: description: country code of the phone type: string example: "52" phoneNumber: description: Phone number of the customer type: string example: "5544332211" prefixLineNumber: description: First 3 or 6 digits of phone number other than country code, area code. type: string maxLength: 6 example: "044" 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" countryCode: description: countryCode type: string example: "" bankInternalAreaUpdated: description: bankInternalAreaUpdated type: string example: "0000" maxLength: 4 serviceProviderId: description: Service provider Id type: string example: "0000" maxLength: 4 bankInternalSubAreaUpdated: description: bankInternalSubAreaUpdated type: string example: "00000000" maxLength: 8 phoneSource: description: phoneSource type: string example: "0000" maxLength: 4 deregistrationDate: description: phone cancel date 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 lastContactedTime: description: last contact time type: string format: date-time example: "2017-07-21T17:32:28Z" riskAlertEnabledFlag: description: Indicates if customer should be contacted or not if a risk is identified type: boolean example: true phoneAdditionalInformation: $ref: '#/definitions/PhoneAdditionalInformation' required: - phoneNumber - bankInternalSubAreaUpdated - riskAlertEnabledFlag PhoneAdditionalInformation: type: object properties: channelCode: description: Phone Media. Telephone registration or modification channel. type: string example: "01" applicationSource: description: Process by which the phone was captured or updated. Example- branch, Fraud etc. type: string maxLength: 2 example: "01" channelPriority: description: The channel with the highest priority that captured the phone. type: string maxLength: 2 example: "01" applicationId: description: Front application that captured or updated the phone. Ex- OneEclipse etc. type: string maxLength: 4 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" 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" 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" accountPrefix: description: accountPrefix type: string example: "0000" maxLength: 4 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 required: - applicationSource - channelPriority - applicationId UpdateCustomerPhoneResponse: 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" required: - lastUpdatedDate - registrationDate UpdateCustomerEmailRequest: type: object properties: customerId: description: Unique identifier of the customer type: string example: "123456789012" sourceSystem: description: It is an identifier for each Front and serves to know where the transaction is made type: string example: "003456" employeeId: description: It is an identifier for the executive payroll (this data is sent by the front) type: string example: 0001494120 email: $ref: '#/definitions/EmailInformation' required: - customerId - sourceSystem - employeeId EmailInformation: 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 serviceProvider: description: This is the provider of the services like yahoo, Hotmail, gmail, etc. type: string example: "0000" 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 riskAlertEnabledFlag: description: Indicates if customer should be contacted or not if a risk is identified type: boolean example: true lastContactedTime: description: last contact time type: string format: date-time example: "2017-07-21T17:32:28Z" lastFailedContactDate: description: last call date type: string format: date example: "2018-02-02" maxLength: 10 deregistrationDate: description: phone cancel date type: string format: date example: "2018-02-02" maxLength: 10 emailAdditionalInformation: $ref: '#/definitions/EmailAdditionalInformation' required: - emailAddress - emailSequenceNumber - cubProcessFlag - riskAlertEnabledFlag EmailAdditionalInformation: type: object properties: verificationType: description: Certification level type type: integer format: int32 example: 1 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 maxLength: 2 example: "01" channelPriority: description: The channel with the highest priority that captured the email. type: string maxLength: 2 example: "01" applicationId: description: Front application that captured or updated the email. Ex- OneEclipse etc. type: string maxLength: 4 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 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 agent: $ref: '#/definitions/AgentInformation' required: - applicationSource - applicationId - channelPriority - verificationType - emailAuthenticationDate - emailStatus AgentInformation: 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" UpdateCustomerEmailResponse: type: object properties: 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 required: - messageText - lastUpdatedDate - registrationDate ErrorResponse: 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 x-ibm-configuration: enforced: true testable: true phase: realized securityDefinitions: OAuth2 Application Flow: type: oauth2 description: "" flow: application scopes: /api/v1: "" tokenUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token Client ID: type: apiKey description: "" in: header name: X-IBM-Client-Id security: - OAuth2 Application Flow: - /api/v1 Client ID: [] x-ibm-endpoints: - endpointUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext type: - production - development ...