---
swagger: "2.0"
info:
  x-ibm-name: customer-registration-to-tpa-api
  title: RAKBANK Customer Registration to Third Party Apps API
  version: 1.1.0
  description: "API allows Third Party App (TPA) back-ends to intimate us whenever
    our customers register on their App, instantly allowing the customer to link his/her
    bank account to the Third Party App (TPA). The API is also to be invoked during
    customer induced deregistration from the Third Party App.\n\n\tVersion 1.1.0\n
    \ - This API must be invoked by the client even in the scenario of customer induced
    account de-linkage from the TPA. The "status" field value should be
    passed as "REG"."
  contact:
    email: apideveloper@rakbank.ae
    name: API developer
  name: ""
schemes:
- https
host: sandboxapi.rakbank.ae
basePath: /v1
consumes:
- application/json
produces:
- application/json
securityDefinitions:
  clientSecretHeader:
    type: apiKey
    description: Client Id of the client App
    in: header
    name: X-IBM-Client-Secret
  clientIdHeader:
    type: apiKey
    in: header
    name: X-IBM-Client-Id
    description: Client Secret of the client App
security:
- clientIdHeader: []
  clientSecretHeader: []
x-ibm-configuration:
  testable: true
  enforced: true
  phase: specified
paths:
  /customers/{customer_id_type}:{customer_id}/tpa_registration_status:
    post:
      responses:
        200:
          description: OK
          schema:
            $ref: '#/definitions/tpa_registration_status'
        422:
          description: Error Response
          schema:
            $ref: '#/definitions/error_response'
        500:
          description: Internal Server Error
          schema:
            $ref: '#/definitions/error_response'
      parameters:
      - name: tpa_registration_status
        required: true
        in: body
        schema:
          $ref: '#/definitions/tpa_registration_status'
        description: Details to update a customer's TPA registration status
      description: Allows status of a customer's TPA registration to be updated
      operationId: UpdateTPARegistrationStatusOfCustomerById
      summary: Update status of a customer's TPA registration at RAKBank
    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 transaction in UUID format
    - name: customer_id
      type: string
      maxLength: 32
      required: true
      in: path
      description: Customer Id of the customer who's details are to be updated. E.g.
        customer UUID.
    - name: customer_id_type
      type: string
      enum:
      - UUID
      required: true
      in: path
      description: Type of the Customer Id of the customer who's TPA registration
        status is to be updated. Allowed values - UUID
definitions:
  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
  tpa_registration_status:
    properties:
      status:
        type: string
        enum:
        - REG
        - DRG
        example: REG
        description: "TPA registration status. Allowed values: \n- REG – Registered
          at TPA.\n  - Passed along with UUID when a specific business banking user
          registers himself/herself on the TPA or when the customer delinks a previously
          linked bank account.\n  \n- DRG - Deregistered at TPA. \n  - Passed along
          with UUID when a specific business banking user is deregisters himself/herself
          on the TPA.\n"
    additionalProperties: false
    description: TPA registration status details
    required:
    - status
tags: []
x-ibm-endpoints:
- endpointUrl: https://sandboxapi.rakbank.ae/sb/api
  type:
  - production
  - development
...