swagger: '2.0'
info:
  description: customer-kyc-consent-aggregator
  version: 1.0.0
  title: customer-kyc-consent
host: api.mtn.com
basePath: /v1/kycConsent
schemes:
  - https
securityDefinitions: 
  OAuth2:
    type: oauth2
    flow: application
    tokenUrl: 'https://api.mtn.com/v1/oauth/access_token?grant_type=client_credentials'
security:
  - OAuth2: []
  
consumes:
  - application/json
produces:
  - application/json
  
tags:
  - name: callback-controller
    description: Callback Controller
  - name: kyc-controller
    description: Kyc Controller
    
paths:
  /callback:
    post:
      tags:
        - callback-controller
      summary: The user consent information posted here as a callback from consent application
      operationId: consentCallbackUsingPOST
      consumes:
        - application/json
      produces:
        - '*/*'
      parameters:
        - name: clientCallbackUrl
          in: header
          description: clientCallbackUrl
          required: true
          type: string
        - in: body
          name: consentCallbackRequest
          description: consentCallbackRequest
          required: true
          schema:
            $ref: '#/definitions/ConsentCallbackRequest'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/CallbackResponse'
        '400':
          description: Bad Request
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
  /individual/{customerId}:
    post:
      tags:
        - kyc-controller
      summary: Endpoint for KYC with Consent.
      operationId: initiateKycWithConsentRequestUsingPOST
      consumes:
        - application/json
      produces:
        - '*/*'
      parameters:
        - name: countryCode
          in: header
          description: countryCode
          required: true
          type: string
        - name: customerId
          in: path
          description: customerId
          required: true
          type: string
        - name: fields
          in: query
          description: fields
          required: false
          type: string
          default: BLANK
          enum:
            - SUBSCRIBER_DETAILS
            - BLANK
        - name: idType
          in: query
          description: idType
          required: false
          type: string
        - in: body
          name: initiateKycConsentRequest
          description: initiateKycConsentRequest
          required: true
          schema:
            $ref: '#/definitions/InitiateKycConsentRequest'
        - name: lob
          in: query
          description: lob
          required: false
          type: string
        - name: partnerCallbackUrl
          in: header
          description: partnerCallbackUrl
          required: true
          type: string
        - name: transactionId
          in: header
          description: transactionId
          required: false
          type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ChenosisKycResponse'
        '400':
          description: Bad Request    
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
definitions:
  CallbackResponse:
    type: object
    properties:
      status:
        type: string
      transactionId:
        type: string
    title: CallbackResponse
  ChenosisKycResponse:
    type: object
    properties:
      application:
        type: string
      consentId:
        type: string
      customerId:
        type: string
      data:
        type: object
      statusCode:
        type: string
      statusMessage:
        type: string
      transactionId:
        type: string
    title: ChenosisKycResponse
  ConsentCallbackData:
    type: object
    properties:
      chenosisCallBackUrl:
        type: string
      consentId:
        type: string
      errorMessage:
        type: string
      status:
        type: string
    title: ConsentCallbackData
  ConsentCallbackRequest:
    type: object
    properties:
      data:
        $ref: '#/definitions/ConsentCallbackData'
      msisdn:
        type: string
      transId:
        type: string
    title: ConsentCallbackRequest
  InitiateKycConsentRequest:
    type: object
    properties:
      channel:
        type: string
      chenosisCallbackUrl:
        type: string
      companyName:
        type: string
      expireInMinutes:
        type: string
      message:
        type: string
    title: InitiateKycConsentRequest