---
swagger: "2.0"
info:
  title: 'Partner Notifications : Retail Account Application Status API'
  version: 1.1.0
  x-ibm-name: partner-notifications-retail-account-application-status-api
  description: "The Partner Retail Account Application API is available to partner
    institutions to initiate the basic account opening process for their new retail
    customers and to update KYC details of the customer once document verification
    is completed from their end. The scanned documents need to be uploaded separately
    to a SFTP server. Post verification of the documents by the RAKBank operations
    and compliance teams, the customer onboarding and account opening would be completed
    and the status would be notified to the partner.\nAt every stage, the status of
    the application will be notified to the client using this API. \n\nThe notifications
    would be sent at three stages as mentioned below. \nStage 2 is optional and may
    apply only to certain individuals where additional details or documents are required
    by the Bank's Compliance team to process the application.\n\n  - Stage 1
    : Initial verification when the application is first created with basic details.\n
    \ - Stage 2 : Request for additional Know Your Customer (KYC) details/documents
    of the customer.\n  - Stage 3 : After final processing with REJECTED or PROCESSED_SUCCESSFULLY
    status.\n  \nThe partner is expected to host the notification API on their server
    as per the documentation provided here.\n\n\tVersion 1.1.0\n\n  - status field
    can also have value "ADDITIONAL_COMPLIANCE_INFO_REQ" - indicating that
    additional document/info of the customer is required by RAKBank compliance team.
    Remarks field will have details of the additional info requested.\n  - remarks
    field will be mandatory when status is 'ADDITIONAL_COMPLIANCE_INFO_REQ'"
  contact:
    email: apideveloper@rakbank.ae
    name: API Developer
  name: ""
schemes:
- https
host: api.partner.ae
basePath: /v1/partner
consumes:
- application/json
produces:
- application/json
x-ibm-configuration:
  testable: false
  enforced: true
  phase: realized
paths:
  /retail/account_applications/{application_id}/application_status:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/application_status'
        422:
          description: Error
          schema:
            $ref: '#/definitions/error_response'
        500:
          description: Internal Sever Error
          schema:
            $ref: '#/definitions/error_response'
      tags: []
      summary: This is used by RAKBANK to update the Partner about the status of a
        Retail Account application during different stages of the customer onboarding
        process.
      operationId: UpdateRetailAccountApplicationStatus
      parameters:
      - name: application_id
        required: true
        in: path
        type: string
        maxLength: 30
        description: Application Id of the application that was submitted earlier.
      - name: application_status
        required: true
        in: body
        schema:
          $ref: '#/definitions/application_status'
        description: status of the application
    parameters:
    - name: MsgId
      type: string
      maxLength: 50
      required: true
      in: header
      description: Unique identifier of the request.
definitions:
  error_response:
    properties:
      response_code:
        type: string
        description: API specific error code
      response_message:
        type: string
        description: brief details of the error
      status:
        type: string
        description: HTTP Status or Request Status
      description:
        type: string
        description: detailed description of the error
      property:
        type: string
    additionalProperties: false
    description: Response in case of error
    required:
    - response_code
    - response_message
    - status
  application_status:
    properties:
      status:
        type: string
        enum:
        - INITIAL_VERIFICATION_SUCCESSFUL
        - REJECTED_AT_INITIAL_VERIFICATION
        - PROCESSED_SUCCESSFULLY
        - REJECTED
        - ADDITIONAL_COMPLIANCE_INFO_REQ
        description: |
          Status to be updated. Valid values:
          - INITIAL_VERIFICATION_SUCCESSFUL - indicating intial verification is successful,
          - REJECTED_AT_INITIAL_VERIFICATION - Rejected at Initial Verification stage,
          - PROCESSED_SUCCESSFULLY -indicating the application was successfully processed i.e. Retail Account opening was successful,
          - REJECTED - indicating that the application was rejected at final stage,
          - ADDITIONAL_COMPLIANCE_INFO_REQ - indicating that additional document or details of the customer is required by RAKBank compliance team. Remarks field will have details of the additional info requested.
        example: PROCESSED_SUCCESSFULLY
      reject_code:
        type: string
        maxLength: 10
        description: Rejection code
      reject_reason:
        type: string
        maxLength: 150
        description: Reason for rejection
      remarks:
        type: string
        maxLength: 3000
        description: Operation Personnel Remarks. Mandatory when status is 'ADDITIONAL_COMPLIANCE_INFO_REQ'
    additionalProperties: false
    required:
    - status
    description: Status object
tags: []
x-ibm-endpoints:
- endpointUrl: https://sandboxapi.rakbank.ae/sb/api
  type:
  - production
  - development
...