---
swagger: "2.0"
info:
  version: 1.0.0
  title: CSMT-CRD-V-CustomerContactInformation
  description: This microservice will manage the contact details for individual and
    corporate customers. This microservice is at the edge layer of the architecture.
  x-ibm-name: csmt-crd-v-customercontactinformation
basePath: /api
schemes:
- https
produces:
- application/json
paths:
  /v1/customers/phone/manage:
    post:
      tags:
      - create-customer-phone
      operationId: create-customer-phone
      summary: To create the customer phone record for the customer
      description: This API is used to create the customer phone record for the customer
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: true
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - 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: true
        type: string
        description: SessionId sent by Consumer
      - name: createCustomerPhoneRequest
        in: body
        schema:
          $ref: '#/definitions/CreateCustomerPhoneRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/CreateCustomerPhoneResponse'
        400:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The request
            operation is not configured to access this resource</td><td>Channel/Country/Business
            provided in the request is not supported currently</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>resourceNotFound</td><td>The requested
            resource was not found</td><td>Empty resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationFailed</td><td>Business
            validation error occured on one or more parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error/server unavailability</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
    put:
      tags:
      - update-customer-phone
      operationId: update-customer-phone
      summary: To update the customer phone record for the customer
      description: This API is used to update the customer phone record for the customer
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: true
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - 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: true
        type: string
        description: SessionId sent by Consumer
      - name: updateCustomerPhoneRequest
        in: body
        schema:
          $ref: '#/definitions/UpdateCustomerPhoneRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/UpdateCustomerPhoneResponse'
        400:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The request
            operation is not configured to access this resource</td><td>Channel/Country/Business
            provided in the request is not supported currently</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>resourceNotFound</td><td>The requested
            resource was not found</td><td>Empty resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationFailed</td><td>Business
            validation error occured on one or more parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error/server unavailability</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
  /v1/customers/email/manage:
    post:
      tags:
      - create-customer-email
      operationId: create-customer-email
      summary: To create the customer email record for the customer
      description: This API is used to create the customer email record for the customer
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: true
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - 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: true
        type: string
        description: SessionId sent by Consumer
      - name: createCustomerEmailRequest
        in: body
        schema:
          $ref: '#/definitions/CreateCustomerEmailRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/CreateCustomerEmailResponse'
        400:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The request
            operation is not configured to access this resource</td><td>Channel/Country/Business
            provided in the request is not supported currently</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>resourceNotFound</td><td>The requested
            resource was not found</td><td>Empty resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationFailed</td><td>Business
            validation error occured on one or more parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error/server unavailability</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
    put:
      tags:
      - update-customer-email
      operationId: update-customer-email
      summary: To update the customer email record for the customer
      description: This API is used to update the customer email record for the customer
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: true
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - 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: true
        type: string
        description: SessionId sent by Consumer
      - name: updateCustomerEmailRequest
        in: body
        schema:
          $ref: '#/definitions/UpdateCustomerEmailRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/UpdateCustomerEmailResponse'
        400:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The request
            operation is not configured to access this resource</td><td>Channel/Country/Business
            provided in the request is not supported currently</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>resourceNotFound</td><td>The requested
            resource was not found</td><td>Empty resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationFailed</td><td>Business
            validation error occured on one or more parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error/server unavailability</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
  /v1/customers/contacts/manage/retrieve:
    post:
      tags:
      - retrieve-customer-contact-detail
      operationId: retrieve-customer-contact-detail
      summary: To get thecontact record for the customer
      description: This api is used to get the contact record for the customer
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: true
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - 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: true
        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: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The request
            operation is not configured to access this resource</td><td>Channel/Country/Business
            provided in the request is not supported currently</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>resourceNotFound</td><td>The requested
            resource was not found</td><td>Empty resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationFailed</td><td>Business
            validation error occured on one or more parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error/server unavailability</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
definitions:
  Security:
    type: object
    properties:
      oneTimePasswordToken:
        type: string
        example: "17364892"
        description: Challenge token generated by the hardToken or softToken assigned
          to the client.
    required:
    - oneTimePasswordToken
  SecurityDetail:
    type: object
    properties:
      jwtToken:
        type: string
        example: kkhljsdf87sdifskjfsdhkf8fsdf
        description: JWT to validate customer email.
    required:
    - jwtToken
  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"
      security:
        $ref: '#/definitions/Security'
      phone:
        $ref: '#/definitions/PhoneDE'
    required:
    - customerId
  PhoneDE:
    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
  PhoneAdditionalDetail:
    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
  CreateCustomerPhoneResponse:
    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"
  CreateCustomerEmailRequest:
    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
  EmailDE:
    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
  EmailAdditionalDetail:
    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
  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:
      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
  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
      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
  PhoneInformation:
    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
  PhoneAdditionalInformation:
    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
  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"
  UpdateCustomerEmailRequest:
    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
  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
      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
  EmailAdditionalInformation:
    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
  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:
      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
  RetrieveCustomerContactRequest:
    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
  RetrieveCustomerContactResponse:
    type: object
    properties:
      emailRecordDetail:
        $ref: '#/definitions/EmailRecordDetail'
      phoneRecordDetail:
        $ref: '#/definitions/PhoneRecordDetail'
  PhoneRecordDetail:
    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/Phone'
    required:
    - customerId
  Phone:
    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'
  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:
      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
  EmailRecordDetail:
    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'
  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
      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'
  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
  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"
  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
...