Toqio User status API

openapi: 3.0.0
info:
  description: Endpoints to manage client accounts
  version: v1.0.0
  title: Accounts Account User status API
  license:
    name: license
servers:
- url: https://api.sandbox.toq.io/wallet/api
  description: Simulation environment
- url: https://api.toq.io/wallet/api
  description: Production environment
tags:
- name: User status
paths:
  /iam/api/customers/{customerId}/merchant/{clientId}/provider/{complianceProvider}/user/{userId}/status/{status}:
    put:
      tags:
      - User status
      summary: Update user status
      description: This endpoint allows to update user status
      operationId: updateUserStatus
      parameters:
      - name: customerId
        in: path
        description: Toqios customer ID
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: clientId
        in: path
        description: Toqios client ID
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: complianceProvider
        in: path
        description: The compliance provider the the action is associated with
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: userId
        in: path
        description: Toqios user ID
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: status
        in: path
        description: The compliance status to be set
        required: true
        style: simple
        explode: false
        schema:
          type: string
          enum:
          - INCOMPLETE
          - NOT_ONBOARDING
          - PENDING_KYC_RESULT
          - PENDING_KYB_RESULTS
          - PENDING_KYC_DOCUMENTS
          - PENDING_KYB_DATA
          - PENDING_KYB
          - PENDING_ACCOUNT
          - COMPLETED
          - DECLINED
          - PENDING_USER_INFO
          - PENDING_KYC
          - REJECTED_FROM_QUARANTINE
          - PENDING_ACCOUNT_VALIDATION
          - REJECTED
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CurrentUserDTO'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
      security:
      - clientCredentials: []
components:
  schemas:
    CurrentUserDTO:
      title: CurrentUserDTO
      type: object
      properties:
        id:
          type: string
        alias:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        phoneNumer:
          type: string
        phoneCountry:
          type: string
        intnlPhoneNumber:
          type: string
        onboardedAt:
          type: string
          format: date
        companyId:
          type: string
        externalId:
          type: string
        username:
          type: string
        onboardingStatus:
          type: string
          enum:
          - INCOMPLETE
          - NOT_ONBOARDING
          - PENDING_KYC_RESULT
          - PENDING_KYB_RESULTS
          - PENDING_KYC_DOCUMENTS
          - PENDING_KYB_DATA
          - PENDING_KYB
          - PENDING_ACCOUNT
          - COMPLETED
          - DECLINED
          - PENDING_USER_INFO
          - PENDING_KYC
          - REJECTED_FROM_QUARANTINE
          - PENDING_ACCOUNT_VALIDATION
          - REJECTED
        overallComplianceStatus:
          type: string
          enum:
          - FROZEN
          - FULLY_REJECTED
          - FULLY_ACCEPTED
          - PARTIALLY_ACCEPTED
          - IN_PROGRESS
          - NOT_STARTED
  securitySchemes:
    clientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.toq.io/iam/oauth/token
          scopes: {}
x-source-pages:
- https://platform.toq.io/reference/createaccountusingpost_1
- https://platform.toq.io/reference/createdynamicaccountconfiguration
- https://platform.toq.io/reference/createproduct
- https://platform.toq.io/reference/deleteaccountstatusviaapiusingdelete
- https://platform.toq.io/reference/deleteaccountviaapiusingput
- https://platform.toq.io/reference/deletedynamicaccountconfiguration
- https://platform.toq.io/reference/getaccountsusingget
- https://platform.toq.io/reference/getaccountusingget
- https://platform.toq.io/reference/getclientaccounts
- https://platform.toq.io/reference/getcustomfaculties
- https://platform.toq.io/reference/getdynamicaccountbuttonconfiguration
- https://platform.toq.io/reference/getledgertypetexts
- https://platform.toq.io/reference/getpartnerproductsusingget_1
- https://platform.toq.io/reference/getproducts
- https://platform.toq.io/reference/updateaccountalias
- https://platform.toq.io/reference/updateaccountreadonlystatus
- https://platform.toq.io/reference/updatecustomfaculties
- https://platform.toq.io/reference/updatedynamicaccountconfiguration
- https://platform.toq.io/reference/updateledgertypetexts
- https://platform.toq.io/reference/updateproduct