---
swagger: "2.0"
info:
  title: CNSV-CSS-D-CustomerSearch
  description: This Microservice is used to get a list of  customers.
  version: 1.0.6
  x-ibm-name: cnsv-css-d-customersearch
  name: ""
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/consumer-services/customers/retrieve:
    post:
      tags:
      - search-customer-list
      operationId: search-customer-list
      summary: To get a list of 20 homonymous customers is retrieved by Name and one
        or more of these parameters address/date of birth/RFC/telephone
      description: This API is used to get a list of 20 homonymous customers is retrieved
        by Name and one or more of these parameters address/date of birth/RFC/telephone
      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
        required: false
        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: 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: channelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - name: dataCenterLocation
        in: header
        description: CSI Data center location number
        required: false
        type: string
        maxLength: 2
      - name: stationName
        in: header
        description: Computer name calling or executing API
        required: false
        type: string
        maxLength: 8
      - name: source
        in: header
        required: true
        type: number
        description: SourceSystem or Source Application calling the API
        maxLength: 6
      - name: operator
        in: header
        required: true
        type: string
        description: Executive ID accesing API
        maxLength: 10
      - name: searchCustomerListRequest
        in: body
        schema:
          $ref: '#/definitions/SearchCustomerListRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/SearchCustomerListResponse'
        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'
        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'
  /private/v1/consumer-services/agents/retrieve:
    post:
      tags:
      - customer-by-agent
      operationId: customer-by-agent
      summary: API to retrieve customers assigned to agent
      description: Customer information retrieved from system 16
      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
        required: false
        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: 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: channelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - name: dataCenterLocation
        in: header
        description: CSI Data center location number
        required: false
        type: string
        maxLength: 2
      - name: stationName
        in: header
        description: Computer name calling or executing API
        required: false
        type: string
        maxLength: 8
      - name: source
        in: header
        required: true
        type: number
        description: SourceSystem or Source Application calling the API
        maxLength: 6
      - name: operator
        in: header
        required: true
        type: string
        description: Executive ID accesing API
        maxLength: 10
      - name: customerByAgentRequest
        in: body
        schema:
          $ref: '#/definitions/customerByAgentRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/CustomerByAgentResponse'
        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'
        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/consumer-services/customers/search/retrieve:
    post:
      tags:
      - search-customer
      operationId: search-customer
      summary: To retrieve the homonymy contact details of the customer
      description: This API is used to retrieve the homonymy contact details of 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: sid
        in: header
        required: true
        type: string
        description: SessionId sent by Consumer
      - name: searchCustomerRequest
        in: body
        schema:
          $ref: '#/definitions/SearchCustomerRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/SearchCustomerResponse'
        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:
  SearchCustomerListRequest:
    type: object
    properties:
      addressLine1:
        description: Address Line 1
        type: string
        example: Reforma 490
      birthDate:
        description: Date of birth of the Person
        type: string
        format: date
        example: "2018-01-02"
      customerName:
        description: Customer Name
        type: string
        example: Josue
      customerType:
        description: Type of the customer
        type: string
        example: Priority
      phoneNumber:
        description: unstrutured/complete Telephone number
        type: string
        example: "1234567890"
      phoneType:
        description: Type of phone
        type: string
        example: Home
      postalCode:
        description: Postal code of address
        type: string
        example: 01219
      taxId:
        description: RFC Number
        type: string
        example: RIVX890228RN0
    required:
    - customerName
  SearchCustomerListResponse:
    type: object
    properties:
      customerDetail:
        type: array
        items:
          $ref: '#/definitions/CustomerDetail'
  CustomerDetail:
    type: object
    properties:
      addressLine1:
        description: Address Line 1
        type: string
        example: Reforma 490
      customerId:
        description: Unique Identifier of the customer
        type: string
        example: "123456789012"
      customerName:
        description: Customer Name
        type: string
        example: Josue
      customerStatus:
        description: Status of the customer
        type: string
        example: "1"
      dataCenterLocation:
        description: Customer CSI Number
        type: string
        example: "1234"
      phoneNumber:
        description: unstrutured/complete Telephone number
        type: string
        example: "1234567890"
      countryCode:
        description: Country Code
        type: string
        example: "01"
      postalCode:
        description: Postal code of address
        type: string
        example: 01219
      taxId:
        description: RFC Number
        type: string
        example: RIVX890228RN0
      curp:
        description: Type of goverment Id number, CURP
        type: string
        example: BEML920313HMCLNS09
      curpValidated:
        description: Field to know if CURP has been validated
        type: string
        example: V
    required:
    - customerName
  customerByAgentRequest:
    type: object
    properties:
      agentId:
        description: agentId
        type: string
        example: ""
        maxLength: 8
      agentType:
        description: agentType
        type: string
        example: ""
        maxLength: 2
      customerId:
        description: customerId
        type: string
        example: ""
        maxLength: 12
    required:
    - agentId
    - agentType
  CustomerByAgentResponse:
    type: object
    properties:
      agent:
        $ref: '#/definitions/Agent'
  Agent:
    type: object
    properties:
      agentId:
        description: agentId
        type: string
        example: ""
        maxLength: 8
      agentName:
        description: agentName
        type: string
        example: ""
        maxLength: 36
      agentType:
        description: agentType
        type: string
        example: ""
        maxLength: 2
      customer:
        type: array
        items:
          $ref: '#/definitions/Customer'
  Customer:
    type: object
    properties:
      customerId:
        description: customerId
        type: string
        example: ""
        maxLength: 12
      fullName:
        description: fullName
        type: string
        example: ""
        maxLength: 55
      agentAssignedDate:
        description: agentAssignedDate
        type: string
        format: date
        example: "2018-04-05"
        maxLength: 10
  SearchCustomerRequest:
    properties:
      fullName:
        description: The legal name that an individual is given at birth and/or recognized
          by a government or other legal entity, or which appears on a birth certificate.
        type: string
        example: Andrea Lopez Hluz
      taxId:
        description: Tax ID Number of  Person or corporation
        type: string
        example: GUGF920725
      addressLine1:
        description: Address Line 1
        type: string
        example: Reforma 490
      phoneNumber:
        description: Phone number of the customer
        type: string
        example: "5518902653"
      postalCode:
        description: Postal code of the address
        type: string
        example: 01219
      stationName:
        description: Station Name
        type: string
        example: "1234"
      birthDate:
        description: Date of birth of the Person
        type: string
        format: date
        example: "2018-01-02"
    required:
    - fullName
  SearchCustomerResponse:
    type: object
    properties:
      contactList:
        type: array
        items:
          $ref: '#/definitions/Contact'
  Contact:
    type: object
    properties:
      dataCenterLocation:
        description: It is an identifier of the place where the User was created.
        type: string
        example: "10"
      customerId:
        description: Customer Id
        type: string
        example: 000004945914
      curp:
        description: CURP id of the customer
        type: string
        example: CHLU141292HFARRL04
      curpValidatedCode:
        description: Field to know if CURP has been validated
        type: string
        example: V
  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://api.banamex.com/mx-gcgapi/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://api.banamex.com/mx-gcgapi
  type:
  - production
  - development
...