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

# List enabled providers for a branch

> Returns the providers that are enabled in onboarding settings for the
specified branch. Branch-level overrides are honoured; when a branch
does not customise its onboarding configuration the organisation-level
configuration is returned.

Use this before calling `POST /api/v2/cases` to confirm which
`checkProvider` and `sofProvider` values are valid for the branch the
case will be created against. Provider identifiers in the response use
the same wire-format strings that `POST /api/v2/cases` accepts.




## OpenAPI

````yaml https://v2.proconvey.co.uk/api/v2/doc get /api/v2/branches/{id}/providers
openapi: 3.1.0
info:
  title: ProConvey Public API
  version: '2.0'
  description: Public API for case management.
servers: []
security: []
tags:
  - name: Cases
    description: Case management operations including creation, retrieval, and data access
  - name: Clients
    description: Client records for the organisation
  - name: Webhooks
    description: >-
      Webhooks available for receiving updates of events on the ProConvey
      platform
  - name: Organisations
    description: Organization management and setup
  - name: System
    description: System and utility endpoints including branches and documentation
paths:
  /api/v2/branches/{id}/providers:
    get:
      tags:
        - Organisations
      summary: List enabled providers for a branch
      description: |
        Returns the providers that are enabled in onboarding settings for the
        specified branch. Branch-level overrides are honoured; when a branch
        does not customise its onboarding configuration the organisation-level
        configuration is returned.

        Use this before calling `POST /api/v2/cases` to confirm which
        `checkProvider` and `sofProvider` values are valid for the branch the
        case will be created against. Provider identifiers in the response use
        the same wire-format strings that `POST /api/v2/cases` accepts.
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
            format: uuid
          description: Branch ID
      responses:
        '200':
          description: Enabled providers grouped by service
          content:
            application/json:
              schema:
                type: object
                properties:
                  branchId:
                    type: string
                    format: uuid
                    description: Branch the result is scoped to
                  idCheck:
                    type: array
                    description: >-
                      Valid values for `clients[].checkProvider` when creating a
                      case
                    items:
                      type: string
                      enum:
                        - yoti
                        - thirdfort
                        - title-guardian
                        - armalytix
                  sourceOfFunds:
                    type: array
                    description: >-
                      Valid values for `clients[].sofProvider` when creating a
                      case. Only applicable when `verificationOfFunds` is true.
                    items:
                      type: string
                      enum:
                        - upload
                        - thirdfort
                        - armalytix
        '400':
          description: Missing branch ID
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '404':
          description: Branch not found or doesn't belong to organisation
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string

````