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

# Get KYB progress

> **Deprecated: use [Get KYB status](/api-reference/organizations/get-kyb-status).** The per-requirement counts here describe Etherfuse's in-house onboarding model, which is being retired. `status` is the one field that carries over, and its values were renamed in this same change: `awaiting_documents` is now `in_progress` and `awaiting_review` is now `submitted`. Both endpoints serve the new names.

Returns KYB progress for a business organization so you can track your customer's verification without portal access: requirement completion counts, the overall status, and the approval timestamp.

The target org must be a business org you own (your own org or a direct child).



## OpenAPI

````yaml /openapi.json get /ramp/organization/{id}/kyb/progress
openapi: 3.1.0
info:
  title: Etherfuse FX API
  description: Partner-facing ramp API for onramps, offramps, swaps, and KYC.
  license:
    name: Proprietary
  version: 1.0.0
servers:
  - url: https://api.sand.etherfuse.com
    description: Sandbox
security:
  - ApiKeyAuth: []
tags:
  - name: Authentication
    description: >-
      Partner JWT authentication — exchange a JWT for an access token, or launch
      a user into the app.
  - name: Lookup
    description: >-
      Public reference data: exchange rates, stablebonds, bond costs, country
      codes.
  - name: Assets
    description: Rampable stablecoins and stablebonds available per blockchain.
  - name: Bank Accounts
    description: Register and retrieve customer bank accounts.
  - name: Quotes
    description: Price quotes for onramps, offramps, and swaps.
  - name: Orders
    description: Create, track, and manage ramp orders.
  - name: Swaps
    description: Crypto-to-crypto swaps.
  - name: Sponsored
    description: Token approvals for sponsored (gasless) offramps.
  - name: Customers
    description: Customer (child-organization) records.
  - name: Wallets
    description: Register and manage customer wallets.
  - name: KYC
    description: >-
      Submit a customer's verification data, documents and questionnaire
      answers, import a verification they already passed elsewhere, and check
      where their KYC stands.
  - name: Webhooks
    description: Event notification subscriptions.
  - name: Organizations
    description: Organization identity, child orgs, and partner fees.
  - name: Statements
    description: >-
      Monthly revenue share statements for closed months, as a list or as a CSV
      or PDF download.
  - name: Deprecated
    description: >-
      Endpoints kept working until their sunset date and then removed. See the
      deprecations page for replacements and dates.
paths:
  /ramp/organization/{id}/kyb/progress:
    get:
      tags:
        - Deprecated
      summary: Get KYB progress
      description: >-
        **Deprecated: use [Get KYB
        status](/api-reference/organizations/get-kyb-status).** The
        per-requirement counts here describe Etherfuse's in-house onboarding
        model, which is being retired. `status` is the one field that carries
        over, and its values were renamed in this same change:
        `awaiting_documents` is now `in_progress` and `awaiting_review` is now
        `submitted`. Both endpoints serve the new names.


        Returns KYB progress for a business organization so you can track your
        customer's verification without portal access: requirement completion
        counts, the overall status, and the approval timestamp.


        The target org must be a business org you own (your own org or a direct
        child).
      operationId: partner_get_kyb_progress
      parameters:
        - name: id
          in: path
          description: The business organization.
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: KYB progress for the organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KybProgressResponse'
        '403':
          description: Not permitted to view this organization
        '404':
          description: Organization not found
      deprecated: true
components:
  schemas:
    KybProgressResponse:
      type: object
      description: >-
        KYB progress for a business organization. Counts cover the
        customer-facing requirements only; admin-only requirements are excluded
        and never affect the status.
      required:
        - organizationId
        - status
        - approved
        - submitted
        - notStarted
        - total
        - approvedAt
      properties:
        organizationId:
          type: string
          format: uuid
          description: ID of the business organization this KYB belongs to.
        status:
          type: string
          enum:
            - not_started
            - in_progress
            - submitted
            - approved
            - denied
          description: >-
            The KYB status. `not_started`: verification hasn't begun.
            `in_progress`: the customer has something left to submit.
            `submitted`: everything the customer can do is done and it's
            Etherfuse's turn, including an open note the customer is waiting on
            an answer to. A note Etherfuse has asked the customer to answer
            reads `in_progress`. `approved`: KYB approved, the business can
            transact. `denied`: KYB denied.
        approved:
          type: integer
          format: int64
          description: Requirements with an approved answer.
        submitted:
          type: integer
          format: int64
          description: Requirements answered but not yet approved.
        notStarted:
          type: integer
          format: int64
          description: Requirements with no answer yet.
        total:
          type: integer
          format: int64
          description: Total applicable requirements (`approved + submitted + notStarted`).
        approvedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: When the org's KYB was approved, or null if not yet approved.
      example:
        organizationId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        status: submitted
        approved: 3
        submitted: 6
        notStarted: 0
        total: 9
        approvedAt: null
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: API key sent in the Authorization header.

````