Toqio pre-signed-url-controller API

openapi: 3.0.0
info:
  description: Endpoints to manage client accounts
  version: v1.0.0
  title: Accounts Account pre-signed-url-controller 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: pre-signed-url-controller
paths:
  /customers/{customerId}/merchant/{merchantId}/presigned-url/upload:
    post:
      tags:
      - pre-signed-url-controller
      summary: Get Pre-signed URLs to upload documents
      operationId: getPreSignedUrls
      parameters:
      - name: customerId
        in: path
        description: customerId
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: merchantId
        in: path
        description: merchantId
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetPreSignedURLPayload'
        description: getPreSignedUrlPayload
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GetPreSignedUrlResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '417':
          description: Validation Exception
      security:
      - OAuth2:
        - openid
      deprecated: false
components:
  schemas:
    GetPreSignedUrlResponse:
      type: object
      properties:
        preSignedUrls:
          type: array
          items:
            properties:
              name:
                type: string
                description: The name of the document
              preSignedUrl:
                type: string
                description: The aws pre-signed url where a PUT call should be made to save the document
              key:
                type: string
                description: 'The path under which the document will be saved in aws. This key should be later on used to save the document in the toqio system by calling another endpoint depending on the case. For example: The uploadKybDocuments'
      title: Get PreSignedUrls Response
      description: The response of the get pre-signed urls
    GetPreSignedURLPayload:
      type: object
      properties:
        section:
          type: string
          description: The section where the documents should be saved
          enum:
          - COMPANY_KYB_DOCUMENTS
          - COMPANY_KYC_DOCUMENTS
          - USER_KYC_DOCUMENTS
          - SHAREHOLDER_DOCUMENTS
        documents:
          type: array
          items:
            properties:
              name:
                type: string
                description: The name of the document
              contentType:
                type: string
                description: The content type of the document
                enum:
                - application/pdf
                - image/jpeg
                - image/png
                - image/tiff
                - image/heic
                - text/csv
                - application/msword
                - application/vnd.openxmlformats-officedocument.wordprocessingml.document
                - application/vnd.ms-excel
                - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
        extraFields:
          type: object
          description: Extra fields required depending on the section. For USER_KYC_DOCUMENTS, an extra field userId is required. For SHAREHOLDER_DOCUMENTS, shareholderId is required.
          properties:
            userId:
              type: string
              description: Required only if the section USER_KYC_DOCUMENTS is set
            shareholderId:
              type: string
              description: Required only if the section SHAREHOLDER_DOCUMENTS is set
      title: Get PreSigned URL
      description: This is the payload to get an aws presigned urls to upload documents.
  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