---
swagger: "2.0"
info:
  title: CSMT-PLM-D-CustomerVerification
  description: This microservice will retreive data for  customer verification.This
    API is Pre-login so SCOPE is VISITOR and SID is required.
  version: 1.1.0
  x-ibm-name: csmt-plm-d-customerverification
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/customers/party/profile-validation:
    post:
      tags:
      - validate-ine-information
      operationId: validate-ine-information
      summary: To validate that customer information provided by the account executive
        exists and make match with the National Electoral Institute (INE for short
        in Spanish) database
      description: This API validates that customer information provided by the account
        executive exists and make match with the National Electoral Institute (INE
        for short in Spanish) database
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: client_secret
        in: header
        required: false
        type: string
        description: Client secret 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 durin application registration
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - name: sid
        in: header
        required: false
        type: string
        description: Session is generated and returned on the first API call of the
          key exchange (GET e2e call) as response header, which needs to be resent
          on succesive calls of same session.
      - name: ineValidationRequest
        in: body
        schema:
          $ref: '#/definitions/IneValidationRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/IneValidationResponse'
        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:
  IneValidationRequest:
    type: object
    properties:
      ipAddress:
        description: IP address of the client that summons this API
        type: string
        example: 100.100.100.100
        maxLength: 15
      branchId:
        description: Branch number where request was generated
        type: string
        example: "2125"
        maxLength: 4
        pattern: ^[0-9]{1,4}$
      agentId:
        description: SOEID of the executive using this API
        type: string
        example: LP00987
        maxLength: 8
      customer:
        $ref: '#/definitions/Customer'
    required:
    - ipAddress
    - branchId
    - agentId
  Customer:
    type: object
    properties:
      consentGivenFlag:
        description: Consent of the client of being consulted
        type: boolean
        example: true
      sourceSystem:
        description: Requests origin system
        type: string
        example: "145850"
        maxLength: 6
        pattern: ^[0-9]{1,6}$
      lastName:
        description: lastName
        type: string
        example: PEREZ
        maxLength: 32
      motherLastName:
        description: motherLastName
        type: string
        example: PEREZ
        maxLength: 32
      firstName:
        description: Name
        type: string
        example: alejandra
        maxLength: 32
      branchPostalCode:
        description: branchPostalCode
        type: string
        example: "9010"
        maxLength: 5
      branchCity:
        description: branchCity
        type: string
        example: MEX.
        maxLength: 20
      branchStateId:
        description: branchStateId
        type: integer
        format: int32
        example: 15
        maxLength: 2
      votingCard:
        $ref: '#/definitions/VotingCard'
    required:
    - customerApproval
    - datacenterLocation
    - branchPostalCode
    - branchCity
    - branchStateId
  VotingCard:
    type: object
    properties:
      voterOcr:
        description: voterOcr
        type: string
        example: "5391079564396"
        maxLength: 13
      voterCic:
        description: voterCic
        type: string
        example: "987645321"
        maxLength: 10
      voterRegisterDate:
        description: voterRegisterDate
        type: string
        example: "2008"
        maxLength: 4
      voterIssuanceYear:
        description: voterIssuanceYear
        type: string
        example: "2016"
        maxLength: 4
      voterIssuance:
        description: voterIssuance
        type: string
        example: "3"
        maxLength: 2
      voterId:
        description: voterId
        type: string
        example: VCMNDV89122915H900
        maxLength: 18
      curp:
        description: curp
        type: string
        example: VIMD891229HMCCNV07
        maxLength: 18
      fingerPrint1:
        description: fingerPrint1
        type: string
        example: ""
      fingerPrint2:
        description: fingerPrint2
        type: string
        example: ""
  IneValidationResponse:
    type: object
    properties:
      cecobanCode:
        description: cecobanCode
        type: string
        example: CRGEN000
        maxLength: 10
      transactionDate:
        description: ineTransactionDate
        type: string
        example: "2018-10-25T17:30:54.968"
        maxLength: 30
      transactionId:
        description: ineTransactionId
        type: string
        example: INCCA4A4352298D2V08HMRUI4
        maxLength: 50
      responseCode:
        description: ineResponseCode
        type: string
        example: "0"
        maxLength: 10
      requestId:
        description: SolicitudID-Unique request ID, in case of retry a request, it
          will be different
        type: string
      customerData:
        $ref: '#/definitions/CustomerData'
  CustomerData:
    type: object
    properties:
      nameFlag:
        description: nameFlag
        type: boolean
        example: true
      lastNameFlag:
        description: lastNameFlag
        type: boolean
        example: true
      motherLastNameFlag:
        description: motherLastNameFlag
        type: boolean
        example: true
      votingCardData:
        $ref: '#/definitions/VotingCardData'
  VotingCardData:
    type: object
    properties:
      ocrFlag:
        description: ocrFlag
        type: boolean
        example: true
      cicFlag:
        description: cicFlag
        type: boolean
        example: true
      registerYearFlag:
        description: registerYearFlag
        type: boolean
        example: true
      issuanceYearFlag:
        description: issuanceYearFlag
        type: boolean
        example: true
      voterIssuanceFlag:
        description: voterIssuanceFlag
        type: boolean
        example: true
      voterIdFlag:
        description: voterIdFlag
        type: boolean
        example: true
      curpFlag:
        description: curpFlag
        type: boolean
        example: true
  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
  ClientID:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Id
security:
- ClientID: []
  OAuth2 Application Flow:
  - /api/v1
x-ibm-endpoints:
- endpointUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
  type:
  - production
  - development
...