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

# List onboardings

> Lists the onboardings of the entity. Only onboardings belonging to the organization of the API key used are visible.

**`v2`** · Base URL `https://api.fintoc.com/v2`


## OpenAPI

````yaml reference/fintoc-api-v2.json GET /entities/{entity_id}/onboardings
openapi: 3.1.0
info:
  title: fintoc-api-v2
  version: v2026-02-01
servers:
  - url: https://api.fintoc.com/v2
security: []
paths:
  /entities/{entity_id}/onboardings:
    get:
      tags:
        - Onboardings
      summary: List onboardings
      description: >-
        Lists the onboardings of the entity. Only onboardings belonging to the
        organization of the API key used are visible.
      operationId: entities-onboardings-list
      parameters:
        - name: entity_id
          in: path
          description: >-
            The unique identifier of the entity (for example
            `ent_8anBwgZktbZH6ydyHa6Tm0eM`).
          required: true
          schema:
            type: string
        - name: ending_before
          in: query
          required: false
          schema:
            type: string
          description: >-
            Cursor for pagination. Use the `id` of the first onboarding on the
            current page to fetch the previous page. Cannot be combined with
            `starting_after`.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 30
          description: >-
            Maximum number of onboardings to return per page. Defaults to 30,
            with a maximum of 300.
        - name: starting_after
          in: query
          required: false
          schema:
            type: string
          description: >-
            Cursor for pagination. Use the `id` of the last onboarding on the
            current page to fetch the next page. Cannot be combined with
            `ending_before`.
      responses:
        '200':
          description: >-
            The list of onboardings of the entity, each as a compact object with
            its status and timestamps.
          headers:
            Link:
              schema:
                type: string
              required: false
              description: >-
                Pagination header. Contains the URL of the next page
                (`rel="next"`) when more results are available.
          content:
            application/json:
              examples:
                onboardings_list:
                  value:
                    - id: onbprc_0ujsswThIGTUYm2K8FjOOfXtY1K
                      object: onboarding
                      entity_id: ent_8anBwgZktbZH6ydyHa6Tm0eM
                      status: pending
                      source: api
                      submitted_at: null
                      reviewed_at: null
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: Unique identifier of the onboarding.
                    object:
                      type: string
                      description: Type of the object. Always `onboarding`.
                    entity_id:
                      type: string
                      description: Identifier of the entity this onboarding belongs to.
                    status:
                      type: string
                      enum:
                        - pending
                        - in_progress
                        - submitted
                        - approved
                        - rejected
                        - cancelled
                      description: >-
                        Current status of the onboarding. One of `pending`,
                        `in_progress`, `submitted`, `approved`, `rejected`, or
                        `cancelled`.
                    source:
                      type: string
                      enum:
                        - api
                        - dashboard
                      description: >-
                        Channel the onboarding is being completed through. One
                        of `api` or `dashboard`.
                    submitted_at:
                      type: string
                      format: date-time
                      nullable: true
                      description: >-
                        ISO 8601 datetime, in UTC, of when the onboarding was
                        submitted for review. `null` until it is submitted.
                    reviewed_at:
                      type: string
                      format: date-time
                      nullable: true
                      description: >-
                        ISO 8601 datetime, in UTC, of when the onboarding was
                        reviewed. `null` until it is reviewed.
                  required:
                    - id
                    - object
                    - entity_id
                    - status
                    - source
                    - submitted_at
                    - reviewed_at
        '400':
          description: >-
            Invalid request: `starting_after` and `ending_before` cannot be used
            at the same time.
          content:
            application/json:
              examples:
                both_cursors:
                  value:
                    error:
                      type: invalid_params
                      code: invalid_params
                      message: >-
                        Cannot use starting_after and ending_before params at
                        the same time
              schema:
                $ref: '#/components/schemas/error_object'
        '401':
          description: Invalid or missing API key.
          content:
            application/json:
              examples:
                invalid_api_key:
                  value:
                    error:
                      type: authentication_error
                      code: invalid_api_key
                      message: 'Invalid API Key: invalid-*oken'
              schema:
                $ref: '#/components/schemas/error_object'
        '404':
          description: The entity does not exist, or belongs to another organization.
          content:
            application/json:
              examples:
                entity_not_found:
                  value:
                    error:
                      type: invalid_request_error
                      code: missing_resource
                      param: entity_id
                      message: 'No such entity: ent_8anBwgZktbZH6ydyHa6Tm0eM'
                      doc_url: https://docs.fintoc.com/reference/errors
              schema:
                $ref: '#/components/schemas/error_object'
      security:
        - api_key: []
components:
  schemas:
    error_object:
      type: object
      properties:
        error:
          type: object
          description: Details of the error that caused the request to fail.
          properties:
            code:
              type: string
              description: >-
                Machine-readable code identifying the specific error, for
                example `invalid_api_key`. Not returned by every error.
              example: invalid_api_key
            doc_url:
              type: string
              description: >-
                URL of a documentation page with more details about the error.
                Not returned by every error.
              example: https://docs.fintoc.com/reference/errors
            message:
              type: string
              description: Human-readable message describing the error.
              example: 'Invalid API Key: invalid-*oken'
            param:
              type:
                - string
                - 'null'
              description: >-
                Name of the request parameter that caused the error. `null` when
                the error cannot be tied to a single parameter, and not returned
                by every error.
              example: amount
            type:
              type: string
              description: >-
                Category of the error, for example `invalid_request_error`,
                `authentication_error`, or `api_error`.
              example: invalid_request_error
          required:
            - type
            - message
  securitySchemes:
    api_key:
      type: apiKey
      name: Authorization
      in: header

````