---
swagger: "2.0"
info:
  title: CustomerAddressUpdateConfirmation
  description: This API is required to confirm the customer’s address updates . This
    is triggered after multi factor authentication is successful.
  version: 1.2.0
  x-ibm-name: CustomerAddressUpdateConfirmation
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/customers/profiles/addresses/confirmation:
    post:
      summary: This API is required to confirm the customer’s address updates . This
        is triggered after multi factor authentication is successful.
      description: This API is required to confirm the customer’s address updates
        . This is triggered after multi factor authentication is successful.
      tags:
      - Customer Service
      parameters:
      - name: Authorization
        in: header
        description: 'The most recent Authorization token. This will have the format
          Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ=='
        type: string
        required: true
      - name: uuid
        in: header
        description: 128 bit random UUID generated uniquely for every request.
        type: string
        required: true
      - name: Accept
        in: header
        description: Content-Type that are acceptable for the response.
        type: string
        required: true
      - name: client_id
        in: header
        description: Client ID generated during application registration.
        required: true
        type: string
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: clientDetails
        in: header
        description: This field is used to capture device,browser and network information.
          Refer the developer portal for more information.These are the fields which
          will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
        type: string
        required: false
      - name: CustomerAddressUpdateConfirmationRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/CustomerAddressUpdateConfirmationRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/CustomerAddressUpdateConfirmationResponse'
        206:
          description: Partial Success.
          schema:
            $ref: '#/definitions/CustomerAddressUpdateConfirmationResponse'
        400:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>invalid</td><td>invalidRequest</td><td>Missing
            or invalid parameters</td></tr><tr><td>error</td><td>invalidControlFlowId</td><td>Control
            Flow Id is invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><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>error</td><td>accessNotConfigured</td><td>Access
            is not configured for this resource</td></tr><tr><td>error</td><td>mfaRequired</td><td>MFA
            is required</td></tr><tr><td>error</td><td>transactionDenied</td><td>Transaction
            Denied</td></tr><tr><td>error</td><td>mfaRequired</td><td>MFA is required</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>DocumentUploadRequired</td><td>Document
            Upload required</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
definitions:
  CustomerAddressUpdateConfirmationRequest:
    properties:
      controlFlowId:
        description: Control Flow Id
        type: string
        example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d
      identificationDocumentDetails:
        $ref: '#/definitions/IdentificationDocumentDetails'
    required:
    - controlFlowId
  IdentificationDocumentDetails:
    properties:
      idType:
        description: Type of Identification document.
        type: string
        example: VI
      idNumber:
        description: 'Unique identifier of identification document. Ex: Passport Number'
        type: string
        example: S42258011
      idExpiryDate:
        description: Expiry date of identification document in ISO 8601 date format
          YYYY-MM-DD
        type: string
        format: date
        example: 1807401600000
      documentReferenceId:
        description: Reference Id to uniquely identify the transaction.This is applicable
          for successful transactions.
        type: string
        example: 3789047384738738
  CustomerAddressUpdateConfirmationResponse:
    properties:
      addressUpdateList:
        type: array
        items:
          $ref: '#/definitions/AddressUpdateDetails'
      card:
        type: array
        items:
          $ref: '#/definitions/Card'
      referenceId:
        description: Unique reference ID associated with the update customer address
          update request.
        type: string
        example: 11000011100002232
  AddressUpdateDetails:
    properties:
      addressType:
        description: Type of the address.
        type: string
        example: HOME_ADDRESS
      responseCode:
        description: Response code of the Address Update
        type: string
        example: 4444
      responseMessage:
        description: Response Message of the Address Update
        type: string
        example: Free text
  Card:
    properties:
      cardId:
        description: The card id  in encrypted format
        type: string
        example: 3255613852316f2b4d4d233213344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d
      mailingIndicatorUpdResponseCode:
        description: Response code of the mailing indicator update.
        type: string
        example: 6546
      mailingIndicatorUpdResponseMessage:
        description: Response Message of the mailing indicator update.
        type: string
        example: Free text
  ErrorResponse:
    properties:
      type:
        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
        type: string
      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 of the error
        type: object
    required:
    - type
    - code
x-ibm-configuration:
  enforced: true
  testable: true
  phase: realized
securityDefinitions:
  API Key:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Id
  API Key(Query):
    type: apiKey
    description: ""
    in: query
    name: client_id
security:
- API Key(Query): []
- API Key: []
x-ibm-endpoints:
- endpointUrl: https://aspac.sit.api.citi.com/gcbap
  description: ""
  type:
  - production
  - development
...