> ## Documentation Index
> Fetch the complete documentation index at: https://docs.boomfi.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Organisation

> Get the authenticated organisation's settings, including webhook public key when configured.



## OpenAPI

````yaml /openapi.yaml get /orgs
openapi: 3.1.0
info:
  contact:
    email: support@boomfi.xyz
    name: API Support
  description: >-
    The BoomFi Merchants API provides a set of endpoints for merchants to manage
    their accounts, transactions, and more. Hosts differ per brand/environment;
    use the brand-specific base URL from the docs.
  title: BoomFi Merchants API
  version: '1.0'
servers:
  - url: https://mapi.boomfi.xyz/v1
    description: Production
  - url: https://mapi-test.boomfi.xyz/v1
    description: Test
security: []
tags:
  - description: Payment links
    name: Paylinks
  - description: Billing plans
    name: Plans
  - description: Subscriptions
    name: Subscriptions
  - description: Customer records
    name: Customers
  - description: Invoices
    name: Invoices
  - description: Payments
    name: Payments
  - description: Organisation events
    name: Events
  - description: Organisation profile and display settings
    name: Organisation
  - description: Webhook and request-signing secrets
    name: Secrets
  - description: Settlement accounts
    name: Accounts
  - name: External Accounts
  - description: Managed virtual accounts, balances, pay-in, and payout
    name: Virtual Accounts
  - description: Partner-managed accounts, virtual accounts, pay-in, and payout
    name: Partners
  - description: Partner maintain-balance automations
    name: Partner Balance Monitoring
  - name: Checkout Sessions
paths:
  /orgs:
    get:
      tags:
        - Organisation
      summary: Get Organisation
      description: >-
        Get the authenticated organisation's settings, including webhook public
        key when configured.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal.Response-orgs_OrgResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal.ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal.ErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    internal.Response-orgs_OrgResponse:
      properties:
        data:
          allOf:
            - $ref: '#/components/schemas/orgs.OrgResponse'
          description: Response payload when the request succeeded.
        error:
          description: True when the request failed.
          type: boolean
        message:
          description: Human-readable status or error message.
          type: string
      type: object
    internal.ErrorResponse:
      properties:
        error:
          allOf:
            - $ref: '#/components/schemas/internal.ErrorStruct'
          description: Error details including HTTP-style code and message.
      type: object
    orgs.OrgResponse:
      properties:
        created_at:
          description: When the resource was created (RFC3339).
          type: string
        id:
          description: Unique resource identifier.
          type: string
        logo_url:
          description: URL of the organisation or partner logo.
          type: string
        name:
          description: Display name.
          type: string
        owner_user_id:
          description: User ID of the organisation owner.
          type: string
        partner_id:
          description: >-
            Identifier of the partner organisation, when this org is under a
            partner.
          type: string
        properties:
          allOf:
            - $ref: '#/components/schemas/orgs.OrgPropertiesResponse'
          description: Additional properties merchant-ui reads.
        updated_at:
          description: When the resource was last updated (RFC3339).
          type: string
        v1:
          description: Legacy v1 payload fields, when present.
        webhook_public_key:
          description: Public key used to verify webhook signatures.
          type: string
        webhook_url:
          description: HTTPS URL that receives webhook events.
          type: string
      type: object
    internal.ErrorStruct:
      properties:
        code:
          description: |-
            Error code
            Example: 400
          example: 400
          type: integer
        errors:
          description: List of errors
          items:
            $ref: '#/components/schemas/internal.SingleError'
          type: array
        message:
          description: |-
            Error message
            Example: Insufficient quantity
          example: Insufficient quantity
          type: string
      type: object
    orgs.OrgPropertiesResponse:
      properties:
        bridge_offramp:
          $ref: '#/components/schemas/orgs.BridgeOfframpResponse'
        currency:
          type: string
        email_notification_options:
          additionalProperties:
            type: boolean
          type: object
        fee_payer:
          type: string
        forwarded_email_recipients:
          items:
            type: string
          type: array
        is_suspended:
          type: boolean
        kyb:
          $ref: '#/components/schemas/orgs.KybResponse'
        kyc:
          $ref: '#/components/schemas/orgs.KycResponse'
        suspension_type:
          type: string
        underpay_thresholds:
          $ref: '#/components/schemas/orgs.UnderpayThresholdsResponse'
      type: object
    internal.SingleError:
      properties:
        domain:
          description: |-
            Domain
            Example: orders
          example: orders
          type: string
        reason:
          description: |-
            Error Reason
            Example: InsufficientQuantity
          example: InsufficientQuantity
          type: string
      type: object
    orgs.BridgeOfframpResponse:
      properties:
        kyc_link:
          properties:
            kyc_status:
              type: string
          type: object
      type: object
    orgs.KybResponse:
      properties:
        createdAt:
          type: string
        fixedInfo:
          $ref: '#/components/schemas/orgs.KybCompanyResponse'
        info:
          $ref: '#/components/schemas/orgs.KybCompanyResponse'
        review:
          $ref: '#/components/schemas/entities.Review'
      type: object
    orgs.KycResponse:
      properties:
        applicant_id:
          type: string
        comment:
          type: string
        created_at:
          type: string
        review_answer:
          type: string
        status:
          type: string
      type: object
    orgs.UnderpayThresholdsResponse:
      properties:
        underpay_tolerance_amount:
          type: number
        underpay_tolerance_currency:
          type: string
        underpay_tolerance_usd:
          type: number
      type: object
    orgs.KybCompanyResponse:
      properties:
        companyInfo:
          properties:
            companyName:
              type: string
          type: object
      type: object
    entities.Review:
      properties:
        attemptCnt:
          type: integer
        attemptId:
          type: string
        createDate:
          type: string
        elapsedSincePendingMs:
          type: integer
        elapsedSinceQueuedMs:
          type: integer
        levelAutoCheckMode: {}
        levelName:
          type: string
        priority:
          type: integer
        reprocessing:
          type: boolean
        reviewDate:
          type: string
        reviewId:
          type: string
        reviewResult:
          $ref: '#/components/schemas/entities.ReviewResult'
        reviewStatus:
          $ref: '#/components/schemas/models.KYCStatus'
      type: object
    entities.ReviewResult:
      properties:
        buttonIds:
          items:
            type: string
          type: array
        clientComment:
          type: string
        moderationComment:
          type: string
        rejectLabels:
          items:
            type: string
          type: array
        reviewAnswer:
          type: string
        reviewRejectType:
          type: string
      type: object
    models.KYCStatus:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
      format: int32
      type: integer
      x-enum-varnames:
        - KYCStatusUnknown
        - KYCStatusInit
        - KYCStatusPending
        - KYCStatusPrechecked
        - KYCStatusQueued
        - KYCStatusCompleted
        - KYCStatusOnHold
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-KEY
      type: apiKey

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.