---
swagger: "2.0"
info:
  x-ibm-name: partner-customer-profile-update-api
  title: Partner Customer Profile Update API
  version: 1.1.0
  description: "This API is available to Partner Institutions to update the profile
    details of all New-To-Bank (NTB) customers, i.e. customers that do not hold any
    bank products other than the retail account opened by the Partner, in the bank
    records.\n\n\tVersion 1.0.1 :\n\n  - Updated the allowed values for document/type
    to EMID\n  - Updated to allow details of prepaid card customers to be updated
    by passing customer_id_type as Emirates_ID\n\n\n\tVersion 1.1.0\n\n  - Added addresses,
    phones and emails fields to allow customer's residence address, mobile number
    and personal email id to be updated."
  contact:
    email: apideveloper@rakbank.ae
    name: API developer
  name: ""
schemes:
- https
host: sandboxapi.rakbank.ae
basePath: /v1
consumes:
- application/json
produces:
- application/json
securityDefinitions:
  oauth:
    type: oauth2
    description: ""
    flow: application
    scopes:
      customers: To update customer's details
    tokenUrl: https://sandboxapi.rakbank.ae/sb/api/oauth2/token
  clientIdHeader:
    type: apiKey
    in: header
    name: X-IBM-Client-Id
security:
- oauth:
  - customers
  clientIdHeader: []
x-ibm-configuration:
  testable: true
  enforced: true
  phase: specified
paths:
  /customers/{customer_id_type}:{customer_id}:
    post:
      responses:
        200:
          description: OK
          schema:
            $ref: '#/definitions/customers'
        422:
          description: Error Response
          schema:
            $ref: '#/definitions/error_response'
        500:
          description: Internal Server Error
          schema:
            $ref: '#/definitions/error_response'
      parameters:
      - name: customers
        required: true
        in: body
        schema:
          $ref: '#/definitions/customers'
        description: Details to update a customer
      description: Allows details of a customer to be updated
      operationId: UpdateCustomerById
      summary: Update details of a customer
    parameters:
    - name: MsgId
      maxLength: 50
      type: string
      required: true
      in: header
      description: Unique Id sent by the client. Value should be a unique identifier
        of the request in UUID format
    - name: customer_id
      type: string
      maxLength: 20
      required: true
      in: path
      description: Customer Id of the customer who's details are to be updated. Masked
        value should be passed in the UAT and Production environments. For information
        on the masking logic to be followed, see <a href=/sb/api/security#masking-logic>Masking
        Logic</a>
    - name: customer_id_type
      type: string
      enum:
      - Account_ID
      - Emirates_ID
      required: true
      in: path
      description: 'Type of the Customer Id of the customer who''s details are to
        be updated. Allowed values: Account_ID - for RAKBank Account holding customers
        , Emirates_ID - for prepaid card customers'
definitions:
  customers:
    properties:
      documents:
        description: Documents
        type: array
        items:
          $ref: '#/definitions/documents'
      addresses:
        type: array
        items:
          $ref: '#/definitions/addresses'
        description: Addresses of the customer.
      phones:
        type: array
        items:
          $ref: '#/definitions/phones'
        description: Phone details of the customer.
      emails:
        type: array
        items:
          $ref: '#/definitions/emails'
        description: Email ids of the customer.
    additionalProperties: false
    description: Customer object that holds details of the customer
  documents:
    properties:
      type:
        type: string
        enum:
        - EMID
        example: EMID
        description: 'Type of the document. Allowed values: EMID - for Emirates ID.'
      number:
        type: string
        minLength: 1
        maxLength: 255
        example: "7982364327852387"
        description: Number of the document.
      expiry_date:
        type: string
        description: Expiry date of the document in ISO 8601 format YYYY-MM-DD.
        example: "2017-09-14"
        format: date
    additionalProperties: false
    required:
    - number
    - type
    - expiry_date
    description: documents
  addresses:
    properties:
      type:
        type: string
        enum:
        - RESIDENCE
        description: Holds address type.  Valid values are "RESIDENCE".
        example: RESIDENCE
      line_1:
        type: string
        maxLength: 50
        description: Holds flat / villa number .
        example: 202 Sky Tower
      line_2:
        type: string
        maxLength: 50
        description: Holds Building / Villa Name.
        example: 23rd Streeet
      line_3:
        type: string
        maxLength: 50
        description: Holds Street Name / Location. To replace previous address details
          with blank, please pass 'NULL^'.
        example: 23rd Streeet
      line_4:
        type: string
        maxLength: 50
        description: Holds Nearest Landmark. To replace previous address details with
          blank, please pass 'NULL^'.
        example: 23rd Streeet
      po_box:
        type: string
        maxLength: 200
        description: P O Box number
        example: "685"
      city:
        type: string
        maxLength: 5
        description: Holds city details. Accepts IATA 3-Letter Codes.
        example: DXB
      country:
        type: string
        maxLength: 2
        description: Holds country details. ISO 2 character Country Codes. See <a
          href=/sb/api/reference-data#country-codes-retail-account-appln>Country Code
          values</a>, for allowed list of values.
        example: AE
      preferred:
        type: boolean
        description: Holds preferred flag value.(true or false)
        example: "true"
    additionalProperties: false
    description: Holds  Address Details of the applicant
    required:
    - type
    - line_1
    - city
    - country
    - preferred
  phones:
    properties:
      type:
        type: string
        enum:
        - CELLPH1
        description: Holds Type of the Phone. Valid Values are "CELLPH1" - mobile
          no.,
        example: CELLPH1
      country_code:
        type: string
        maxLength: 10
        description: Holds the country_code for the phone number
        example: 971
      number:
        type: string
        maxLength: 25
        description: Holds the mobile phone number
        example: "512345678"
    additionalProperties: false
    description: Holds contact details of the applicant
    required:
    - type
    - country_code
    - number
  emails:
    properties:
      type:
        type: string
        enum:
        - HOMEEML
        description: Holds Email Address Type. Valid values - "HOMEEML" - Personal
          email id
        example: HOMEEML
      email:
        type: string
        maxLength: 150
        description: Holds email address value.
        example: abc@email.com
    additionalProperties: false
    description: Holds mail details of the applicant
    required:
    - email
    - type
  error_response:
    properties:
      status:
        type: string
        description: HTTP Status
      response_code:
        type: string
        description: API specific error code
      property:
        type: string
        description: ""
      response_message:
        type: string
        description: brief details of the error
      description:
        type: string
        description: detailed description of the error
    additionalProperties: false
    required:
    - response_message
    - response_code
    - status
    description: Response in case of error
tags: []
x-ibm-endpoints:
- endpointUrl: https://sandboxapi.rakbank.ae/sb/api
  type:
  - production
  - development
...