---
swagger: "2.0"
info:
  title: CSMT-CRM-D-DemographicProfile
  description: Gets the customer's information and data center location
  version: 1.3.0
  x-ibm-name: csmt-crm-d-demographicprofile
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/customers/datacenter-location:
    post:
      tags:
      - customer-datacenter-location
      operationId: customer-datacenter-location
      summary: Gets Customer's CSI
      description: Gets Customer's CSI
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - 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: retrieveCustomerCSIRequest
        in: body
        schema:
          $ref: '#/definitions/RetrieveCustomerCSIRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RetrieveCustomerCSIResponse'
        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/customers/profiles/information:
    post:
      tags:
      - customer-information
      operationId: customer-information
      summary: Gets Personal and Demographics data of customer
      description: Gets Customer information
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - 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: retrieveCustomerInformationRequest
        in: body
        schema:
          $ref: '#/definitions/RetrieveCustomerInformationRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RetrieveCustomerInformationResponse'
        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/customers/profiles/detail:
    post:
      tags:
      - customer-detail
      operationId: customer-detail
      summary: To retrieve brief Personal and Demographics data of the customer to
        classify the customer segment.
      description: This API is used to retrieve brief Personal and Demographics data
        of the customer to classify the customer segment
      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: false
        type: string
        description: SessionId sent by Consumer
      - name: retrieveCustomerDetailRequest
        in: body
        schema:
          $ref: '#/definitions/RetrieveCustomerDetailRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RetrieveCustomerDetailResponse'
        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'
definitions:
  RetrieveCustomerCSIRequest:
    type: object
    properties:
      branchId:
        description: branchId
        type: integer
        example: 1234
        maxLength: 4
      accountNumber:
        description: accountNumber
        type: number
        format: biginteger
        example: 123456789012
        maxLength: 12
      customerId:
        description: Customer Id
        type: string
        example: "232343425"
  RetrieveCustomerCSIResponse:
    type: object
    properties:
      dataCenterLocation:
        description: Data Center location (CSI)
        type: string
        example: 10
    required:
    - dataCenterLocation
  RetrieveCustomerDetailResponse:
    type: object
    properties:
      birthDate:
        description: Customer's birthdate in format dd-mm-yyyy for IVR channel and
          format yyyy-mm-dd for all channels
        type: string
        format: date
        example: "2000-11-23"
      customerSegment:
        description: Segment where the Customer belongs
        type: string
        example: 20
      fullName:
        description: Full name of the customer
        type: string
        example: Luis Diaz Salinas
    required:
    - backgroundRiskCode
    - birthDate
    - customerSegment
    - customerStatus
    - customerType
    - fullName
  RetrieveCustomerInformationResponse:
    type: object
    properties:
      backgroundRiskCode:
        description: Banamex risk code
        type: string
        example: "00"
      customerId:
        description: Customer Id
        type: string
        example: "36454546534"
      birthDate:
        description: Customer's birthdate in format dd-mm-yyyy for IVR channel and
          format yyyy-mm-dd for all channels
        type: string
        format: date
        example: "2000-11-23"
      customerSegment:
        description: Segment where the Customer belongs
        type: string
        example: 20
      customerStatus:
        description: Status of the customer
        type: string
        example: 1
      citiEmployeeFlag:
        description: Flag to tell if the person is citi employee
        type: boolean
        example: "True"
      customerType:
        description: Type of the customer
        type: string
        example: 11
      fullName:
        description: Full name of the customer
        type: string
        example: Luis Diaz Salinas
      customerSinceDate:
        description: The date customer is associated with Financial Institution
        type: string
        format: date
        example: "1990-10-15"
      dataCenterLocation:
        description: dataCenterLocation
        type: integer
        example: 10
      phones:
        type: array
        items:
          $ref: '#/definitions/Phones'
    required:
    - backgroundRiskCode
    - birthDate
    - customerSegment
    - customerStatus
    - customerType
    - fullName
  Phones:
    type: object
    properties:
      areaCode:
        description: Area code where the phone belongs
        type: integer
        example: 52
      extensionNumber:
        description: Extension for the phone
        type: integer
        example: 343
      phoneNumber:
        description: Phone number
        type: string
        example: "7221567676"
  RetrieveCustomerDetailRequest:
    type: object
    properties:
      customerId:
        description: Unique identifier for the Customer
        type: string
        example: "98346298349"
      cardNumber:
        description: Card number
        type: string
        example: "4969452123456110"
        maxLength: 16
      account:
        $ref: '#/definitions/AccountDetail'
  AccountDetail:
    type: object
    properties:
      accountAccessPrefix:
        description: First 4 digits from the account or card
        type: string
        example: "5211"
      branchId:
        description: branchId
        type: integer
        example: 1234
        maxLength: 4
      accountNumber:
        description: accountNumber
        type: string
        example: "1234567890123456"
        maxLength: 16
      product:
        $ref: '#/definitions/ProductDetail'
  ProductDetail:
    type: object
    properties:
      productNumber:
        type: string
        example: "1234"
        description: Product code
      instrumentCode:
        type: string
        example: "12"
        description: product Instrument Code
  RetrieveCustomerInformationRequest:
    type: object
    properties:
      customerId:
        description: Unique identifier for the Customer
        type: string
        example: "98346298349"
      cardNumber:
        description: Card number
        type: string
        example: "4969452123456110"
        maxLength: 16
      account:
        $ref: '#/definitions/Account'
  Account:
    type: object
    properties:
      accountAccessPrefix:
        description: First 4 digits from the account or card
        type: string
        example: "5211"
      branchId:
        description: branchId
        type: integer
        example: 1234
        maxLength: 4
      accountNumber:
        description: accountNumber
        type: string
        example: "1234567890123456"
        maxLength: 16
      product:
        $ref: '#/definitions/Product'
  Product:
    type: object
    properties:
      productNumber:
        type: string
        example: "1234"
        description: Product code
      instrumentCode:
        type: string
        example: "12"
        description: product Instrument Code
  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: More Info can be used to pass any additional details
        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
...