openapi: 3.2.0
info:
  title: fiat-republic Documents API
  version: '1.0'
servers:
- url: https://sandbox.fiatrepublic.com/api/v1
security:
- sec0: []
tags:
- name: Documents
paths:
  /documents:
    post:
      summary: Create Document
      description: ''
      operationId: create-document
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                file:
                  type: string
                  description: 'Allowed formats: JSON, JPEG, PDF, PNG'
                  format: binary
                metadata:
                  type: object
                  properties:
                    description:
                      type: string
                    type:
                      type: string
                      description: To enable USD, please choose IDENTITY_VERIFICATION
                      enum:
                      - IDENTITY_VERIFICATION
                      - PASSPORT
                      - CERTIFICATE_OF_INCORPORATION
                    relatedEntityIds:
                      type: array
                      description: IDs of related End User or Business object
                      items:
                        type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n    \"id\": \"doc_ov8jkx67ny1dbzzzzz\",\n    \"type\": \"IDENTITY_VERIFICATION\",\n    \"description\": \"LedgerPlus UBO IV\",\n    \"relatedEntityIds\": [\n        \"eus_p9mnzv0pkozxxxxxxx\"\n    ],\n    \"format\": \"PDF\",\n    \"originalName\": \"Passport_Page.pdf\",\n    \"createdAt\": 1747827809851\n}"
              schema:
                type: object
                properties:
                  id:
                    type: string
                    example: doc_ov8jkx67ny1dbzzzzz
                  type:
                    type: string
                    example: IDENTITY_VERIFICATION
                  description:
                    type: string
                    example: LedgerPlus UBO IV
                  relatedEntityIds:
                    type: array
                    items:
                      type: string
                      example: eus_p9mnzv0pkozxxxxxxx
                  format:
                    type: string
                    example: PDF
                  originalName:
                    type: string
                    example: Passport_Page.pdf
                  createdAt:
                    type: integer
                    example: 1747827809851
                    default: 0
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      x-readme:
        code-samples:
        - code: "curl --request POST \\\n  --url https://sandbox.fiatrepublic.com/api/v1/documents \\\n  --header 'accept: application/json' \\\n  --form 'file=@your_document_name.pdf;type=application/pdf' \\\n  --form 'metadata={\n    \"documentType\": \"KYC\",\n    \"memberId\": \"123456\"\n  };type=application/json'\n"
          language: json
          name: ''
        samples-languages:
        - json
      tags:
      - Documents
    get:
      summary: Get Document
      description: ''
      operationId: get-documents
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: ID of the document
                relatedEntityId:
                  type: string
                  description: IDs of related End User or Business object
                format:
                  type: string
                  description: JSON, JPEG, PDF, PNG
                search:
                  type: string
                limit:
                  type: string
                offset:
                  type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      tags:
      - Documents
  /documents/{id}:
    patch:
      summary: Update Document
      description: ''
      operationId: update-document
      parameters:
      - name: id
        in: path
        schema:
          type: string
        required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                relatedEntityIds:
                  type: array
                  description: Provide the End User ID(s) or Business ID(s) to link this document to the relevant entity
                  items:
                    type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Documents
components:
  securitySchemes:
    sec0:
      type: oauth2
      flows: {}
x-readme-fauxas: true
x-provenance:
  method: searched
  source: https://docs.fiatrepublic.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.fiatrepublic.com/reference/create-business-end-user.md
  - https://docs.fiatrepublic.com/reference/create-conversion.md
  - https://docs.fiatrepublic.com/reference/create-document.md
  - https://docs.fiatrepublic.com/reference/create-emt-payee.md
  - https://docs.fiatrepublic.com/reference/create-emt-payment.md
  - https://docs.fiatrepublic.com/reference/create-fiat-account.md
  - https://docs.fiatrepublic.com/reference/create-individual-end-user.md
  - https://docs.fiatrepublic.com/reference/create-payee.md
  - https://docs.fiatrepublic.com/reference/create-payin.md
  - https://docs.fiatrepublic.com/reference/create-payment.md
  - https://docs.fiatrepublic.com/reference/create-quote.md
  - https://docs.fiatrepublic.com/reference/create-return.md
  - https://docs.fiatrepublic.com/reference/create-virtual-account.md
  - https://docs.fiatrepublic.com/reference/create-webhook.md
  - https://docs.fiatrepublic.com/reference/delete-emt-payee.md
  - https://docs.fiatrepublic.com/reference/delete-payee.md
  - https://docs.fiatrepublic.com/reference/delete-webhook.md
  - https://docs.fiatrepublic.com/reference/get-business-end-user.md
  - https://docs.fiatrepublic.com/reference/get-business.md
  - https://docs.fiatrepublic.com/reference/get-conversion.md
  - https://docs.fiatrepublic.com/reference/get-documents.md
  - https://docs.fiatrepublic.com/reference/get-emt-payee.md
  - https://docs.fiatrepublic.com/reference/get-emt-payer.md
  - https://docs.fiatrepublic.com/reference/get-emt-payment.md
  - https://docs.fiatrepublic.com/reference/get-emt-wallet.md
  - https://docs.fiatrepublic.com/reference/get-fiat-account-copy.md
  - https://docs.fiatrepublic.com/reference/get-fiat-account.md
  - https://docs.fiatrepublic.com/reference/get-individual-end-user.md
  - https://docs.fiatrepublic.com/reference/get-member-details.md
  - https://docs.fiatrepublic.com/reference/get-member-review-settings.md
  - https://docs.fiatrepublic.com/reference/get-payee-verification.md
  - https://docs.fiatrepublic.com/reference/get-payee.md
  - https://docs.fiatrepublic.com/reference/get-payer.md
  - https://docs.fiatrepublic.com/reference/get-payment.md
  - https://docs.fiatrepublic.com/reference/get-return.md
  - https://docs.fiatrepublic.com/reference/get-transaction.md
  - https://docs.fiatrepublic.com/reference/get-virtual-account-transactions.md
  - https://docs.fiatrepublic.com/reference/get-virtual-account.md
  - https://docs.fiatrepublic.com/reference/get-webhook.md
  - https://docs.fiatrepublic.com/reference/list-business-end-users.md
  - https://docs.fiatrepublic.com/reference/list-conversions.md
  - https://docs.fiatrepublic.com/reference/list-emt-payees.md
  - https://docs.fiatrepublic.com/reference/list-emt-payers.md
  - https://docs.fiatrepublic.com/reference/list-emt-payments.md
  - https://docs.fiatrepublic.com/reference/list-emt-wallets.md
  - https://docs.fiatrepublic.com/reference/list-fiat-accounts.md
  - https://docs.fiatrepublic.com/reference/list-individual-end-users.md
  - https://docs.fiatrepublic.com/reference/list-member-businesses.md
  - https://docs.fiatrepublic.com/reference/list-payee.md
  - https://docs.fiatrepublic.com/reference/list-payers.md
  - https://docs.fiatrepublic.com/reference/list-payments.md
  - https://docs.fiatrepublic.com/reference/list-returns.md
  - https://docs.fiatrepublic.com/reference/list-transactions.md
  - https://docs.fiatrepublic.com/reference/list-virtual-accounts.md
  - https://docs.fiatrepublic.com/reference/list-webhook-notifications.md
  - https://docs.fiatrepublic.com/reference/list-webhooks.md
  - https://docs.fiatrepublic.com/reference/payee-verification-review.md
  - https://docs.fiatrepublic.com/reference/payment-review.md
  - https://docs.fiatrepublic.com/reference/transactions-summary.md
  - https://docs.fiatrepublic.com/reference/update-business-end-user.md
  - https://docs.fiatrepublic.com/reference/update-document.md
  - https://docs.fiatrepublic.com/reference/update-fiat-account.md
  - https://docs.fiatrepublic.com/reference/update-individual-end-user.md
  - https://docs.fiatrepublic.com/reference/update-member-review-settings.md
  - https://docs.fiatrepublic.com/reference/update-payee.md
  - https://docs.fiatrepublic.com/reference/update-virtual-account.md
  - https://docs.fiatrepublic.com/reference/update-webhook.md
  - https://docs.fiatrepublic.com/reference/validate-payee.md
  - https://docs.fiatrepublic.com/reference/verify-payee.md
  merge:
    pages: 69
    deduped: 68
    conflicts_kept_first: 0