Candid Health

Candid Health V2 API

The v2 API from Candid Health — 25 operation(s) for v2.

Documentation GitHub OpenAPI

Operations 43

POST /api/billing_notes/v2 Create billing note #

DELETE /api/billing_notes/v2/{billing_note_id} Delete billing note #

PATCH /api/billing_notes/v2/{billing_note_id} Update #

GET /api/contracts/v2/{contract_id} Get contract #

DELETE /api/contracts/v2/{contract_id} Delete contract #

PATCH /api/contracts/v2/{contract_id} Update contract #

GET /api/contracts/v2 Get all contracts #

POST /api/contracts/v2 Create contract #

POST /api/provider-credentialing-span/v2/facility Create facility credentialing span #

GET /api/provider-credentialing-span/v2/facility Get all facility credentialing spans #

GET /api/provider-credentialing-span/v2/facility/{facility_credentialing_id} Get facility credentialing span #

DELETE /api/provider-credentialing-span/v2/facility/{facility_credentialing_id} Delete facility credentialing span #

PATCH /api/provider-credentialing-span/v2/facility/{facility_credentialing_id} Update facility credentialing span #

POST /api/provider-credentialing-span/v2 Create provider credentialing span #

GET /api/provider-credentialing-span/v2 Get all provider credentialing spans #

GET /api/provider-credentialing-span/v2/{provider_credentialing_id} Get provider credentialing span #

DELETE /api/provider-credentialing-span/v2/{provider_credentialing_id} Delete provider credentialing span #

PATCH /api/provider-credentialing-span/v2/{provider_credentialing_id} Update provider credentialing span #

GET /api/eligibility/v2/availity Submit encounter eligibility check (Availity) #

POST /api/eligibility/v2/availity Submit encounter eligibility check (Availity Post) #

PATCH /api/encounter-providers/v2/{encounter_id} Update Referring Provider #

PATCH /api/encounter-providers/v2/{encounter_id}/initial-referring-provider Update Initial Referring Provider #

DELETE /api/encounter-providers/v2/{encounter_id}/initial-referring-provider Delete Initial Referring Provider #

PATCH /api/encounter-providers/v2/{encounter_id}/supervising-provider Update Supervising Provider #

DELETE /api/encounter-providers/v2/{encounter_id}/supervising-provider Delete Supervising Provider #

PATCH /api/encounter-providers/v2/{service_line_id}/ordering-provider Update Ordering Provider #

DELETE /api/encounter-providers/v2/{service_line_id}/ordering-provider Delete Ordering Provider #

POST /api/encounter-providers/v2/{encounter_id}/create-referring-provider Create Referring Provider #

POST /api/encounter-providers/v2/{encounter_id}/create-initial-referring-provider Create Initial Referring Provider #

POST /api/encounter-providers/v2/{encounter_id}/create-supervising-provider Create Supervising Provider #

POST /api/encounter-providers/v2/{service_line_id}/create-ordering-provider Create Ordering Provider #

DELETE /api/encounter-providers/v2/{encounter_id}/referring-provider Delete Referring Provider #

GET /api/organization-service-facilities/v2/{organization_service_facility_id} Get organization service facility #

PATCH /api/organization-service-facilities/v2/{organization_service_facility_id} Update organization service facility #

DELETE /api/organization-service-facilities/v2/{organization_service_facility_id} Delete organization service facility #

GET /api/organization-service-facilities/v2 Get all organization service facilities #

POST /api/organization-service-facilities/v2 Create organization service facility #

GET /api/organization-service-facilities/v2/external-id/{external_id} Get organization service facility by external_id #

POST /api/service-lines/v2 Create Service Line #

POST /api/service-lines/v2/universal Create Professional or Institutional Service Line #

PATCH /api/service-lines/v2/{service_line_id}/universal Update service line for encounter that may be institutional or professional. #

PATCH /api/service-lines/v2/{service_line_id} Update Service Line #

DELETE /api/service-lines/v2/{service_line_id} Delete Service Line #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/candid-health-v2-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Reference V2 API
  version: 1.0.0
servers:
- url: https://pre-api.joincandidhealth.com
  description: Production
- url: https://pre-api-staging.joincandidhealth.com
  description: Staging
- url: https://sandbox-pre-api.joincandidhealth.com
  description: CandidSandbox
- url: https://staging-pre-api.joincandidhealth.com
  description: CandidStaging
- url: http://localhost:4000
  description: Local
- url: https://api.joincandidhealth.com
  description: Production
- url: https://api-staging.joincandidhealth.com
  description: Staging
- url: https://sandbox-api.joincandidhealth.com
  description: CandidSandbox
- url: https://staging-api.joincandidhealth.com
  description: CandidStaging
- url: http://localhost:5050
  description: Local
tags:
- name: v2
paths:
  /api/billing_notes/v2:
    post:
      operationId: create
      summary: Create billing note
      tags:
      - v2
      parameters:
      - name: Authorization
        in: header
        description: OAuth authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_billing-notes_v2_BillingNote'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: Empty string not allowed.
                encounter_id:
                  $ref: '#/components/schemas/type_commons_EncounterId'
              required:
              - text
              - encounter_id
  /api/billing_notes/v2/{billing_note_id}:
    delete:
      operationId: delete
      summary: Delete billing note
      tags:
      - v2
      parameters:
      - name: billing_note_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_billing-notes_v2_BillingNoteId'
      - name: Authorization
        in: header
        description: OAuth authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - OrganizationNotAuthorizedError
                  content:
                    $ref: '#/components/schemas/type_commons_OrganizationNotAuthorizedErrorMessage'
                required:
                - errorName
                - content
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - UnauthorizedError
                  content:
                    $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage'
                required:
                - errorName
                - content
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - EntityNotFoundError
                  content:
                    $ref: '#/components/schemas/type_commons_EntityNotFoundErrorMessage'
                required:
                - errorName
                - content
    patch:
      operationId: update
      summary: Update
      tags:
      - v2
      parameters:
      - name: billing_note_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_billing-notes_v2_BillingNoteId'
      - name: Authorization
        in: header
        description: OAuth authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_billing-notes_v2_BillingNote'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - OrganizationNotAuthorizedError
                  content:
                    $ref: '#/components/schemas/type_commons_OrganizationNotAuthorizedErrorMessage'
                required:
                - errorName
                - content
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - UnauthorizedError
                  content:
                    $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage'
                required:
                - errorName
                - content
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - EntityNotFoundError
                  content:
                    $ref: '#/components/schemas/type_commons_EntityNotFoundErrorMessage'
                required:
                - errorName
                - content
        '422':
          description: Error response with status 422
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - HttpRequestValidationsError
                  content:
                    type: array
                    items:
                      $ref: '#/components/schemas/type_commons_RequestValidationError'
                required:
                - errorName
                - content
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: Empty string not allowed.
              required:
              - text
  /api/contracts/v2/{contract_id}:
    get:
      operationId: get
      summary: Get contract
      description: This API provides access to Professional Contracts. For Professional and Institutional Contracts use Contracts V3.
      tags:
      - v2
      parameters:
      - name: contract_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_contracts_v2_ContractId'
      - name: organization_id
        in: query
        description: Organization context for cross-org access. If not provided, defaults to the requesting user's organization.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons_OrganizationId'
      - name: Authorization
        in: header
        description: OAuth authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_contracts_v2_ContractWithProviders'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - EntityNotFoundError
                  content:
                    $ref: '#/components/schemas/type_commons_EntityNotFoundErrorMessage'
                required:
                - errorName
                - content
    delete:
      operationId: delete
      summary: Delete contract
      tags:
      - v2
      parameters:
      - name: contract_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_contracts_v2_ContractId'
      - name: Authorization
        in: header
        description: OAuth authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '422':
          description: Error response with status 422
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - ContractIsLinkedToFeeScheduleHttpError
                  content:
                    $ref: '#/components/schemas/type_contracts_v2_ContractIsLinkedToFeeScheduleError'
                required:
                - errorName
                - content
    patch:
      operationId: update
      summary: Update contract
      tags:
      - v2
      parameters:
      - name: contract_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_contracts_v2_ContractId'
      - name: Authorization
        in: header
        description: OAuth authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_contracts_v2_ContractWithProviders'
        '422':
          description: Error response with status 422
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - ContractInvalidExpirationDateHttpError
                  content:
                    $ref: '#/components/schemas/type_contracts_v2_ContractInvalidExpirationDateError'
                required:
                - errorName
                - content
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                rendering_provider_ids:
                  type: array
                  uniqueItems: true
                  items:
                    $ref: '#/components/schemas/type_contracts_v2_RenderingProviderid'
                  description: 'A rendering provider isn''t contracted directly with the payer but can render

                    services under the contract held by the contracting provider.

                    Max items is 4000.'
                effective_date:
                  $ref: '#/components/schemas/type_commons_Date'
                  description: The starting day upon which the contract is effective
                expiration_date:
                  $ref: '#/components/schemas/type_contracts_v2_DateUpdate'
                  description: An optional end day upon which the contract expires
                regions:
                  $ref: '#/components/schemas/type_contracts_v2_RegionsUpdate'
                  description: 'If present, the contract''s rendering providers will be patched to this exact

                    value, overriding what was set before.'
                contract_status:
                  $ref: '#/components/schemas/type_contracts_v2_ContractStatus'
                authorized_signatory:
                  $ref: '#/components/schemas/type_contracts_v2_AuthorizedSignatoryUpdate'
                commercial_insurance_types:
                  $ref: '#/components/schemas/type_contracts_v2_InsuranceTypes'
                medicare_insurance_types:
                  $ref: '#/components/schemas/type_contracts_v2_InsuranceTypes'
                medicaid_insurance_types:
                  $ref: '#/components/schemas/type_contracts_v2_InsuranceTypes'
  /api/contracts/v2:
    get:
      operationId: get_multi
      summary: Get all contracts
      description: This API provides access to Professional Contracts. For Professional and Institutional Contracts use Contracts V3.
      tags:
      - v2
      parameters:
      - name: page_token
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons_PageToken'
      - name: limit
        in: query
        description: Max number of contracts returned. Defaults to 1000. Max is 1000.
        required: false
        schema:
          type: integer
      - name: contracting_provider_id
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_contracts_v2_ContractingProviderId'
      - name: rendering_provider_ids
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_contracts_v2_RenderingProviderid'
      - name: payer_names
        in: query
        description: Filter to contracts that include any of the included payer names.
        required: false
        schema:
          type: string
      - name: states
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons_State'
      - name: contract_status
        in: query
        description: The status of the contract. Defaults to `pending`
        required: false
        schema:
          $ref: '#/components/schemas/type_contracts_v2_ContractStatus'
      - name: sort
        in: query
        description: Potentially sort by a contract related attribute.  Defaults to created_at
        required: false
        schema:
          $ref: '#/components/schemas/type_contracts_v2_ContractSortField'
      - name: sort_direction
        in: query
        description: Direction of sort, defaulting to desc
        required: false
        schema:
          $ref: '#/components/schemas/type_commons_SortDirection'
      - name: Authorization
        in: header
        description: OAuth authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_contracts_v2_ContractsPage'
    post:
      operationId: create
      summary: Create contract
      description: Creates a new contract within the user's current organization
      tags:
      - v2
      parameters:
      - name: Authorization
        in: header
        description: OAuth authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_contracts_v2_ContractWithProviders'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                effective_date:
                  $ref: '#/components/schemas/type_commons_Date'
                  description: The starting day upon which the contract is effective
                expiration_date:
                  $ref: '#/components/schemas/type_commons_Date'
                  description: An optional end day upon which the contract expires
                regions:
                  $ref: '#/components/schemas/type_commons_Regions'
                  description: 'The state(s) to which the contract''s coverage extends.

                    It may also be set to "national" for the entirety of the US.'
                contract_status:
                  $ref: '#/components/schemas/type_contracts_v2_ContractStatus'
                authorized_signatory:
                  $ref: '#/components/schemas/type_contracts_v2_AuthorizedSignatory'
                commercial_insurance_types:
                  $ref: '#/components/schemas/type_contracts_v2_InsuranceTypes'
                  description: The commercial plan insurance types this contract applies.
                medicare_insurance_types:
                  $ref: '#/components/schemas/type_contracts_v2_InsuranceTypes'
                  description: The Medicare plan insurance types this contract applies.
                medicaid_insurance_types:
                  $ref: '#/components/schemas/type_contracts_v2_InsuranceTypes'
                  description: The Medicaid plan insurance types this contract applies.
                contracting_provider_id:
                  $ref: '#/components/schemas/type_contracts_v2_ContractingProviderId'
                  description: The UUID of the provider under agreement to the contract
                rendering_provider_ids:
                  type: array
                  uniqueItems: true
                  items:
                    $ref: '#/components/schemas/type_contracts_v2_RenderingProviderid'
                  description: 'A rendering provider isn''t contracted directly with the payer but can render

                    services under the contract held by the contracting provider.

                    Max items is 4000.'
                payer_uuid:
                  type: string
                  format: uuid
                  description: The UUID of the insurance company under agreement to the contract
              required:
              - effective_date
              - regions
              - commercial_insurance_types
              - medicare_insurance_types
              - medicaid_insurance_types
              - contracting_provider_id
              - rendering_provider_ids
              - payer_uuid
  /api/provider-credentialing-span/v2/facility:
    post:
      operationId: createFacility
      summary: Create facility credentialing span
      tags:
      - v2
      parameters:
      - name: Authorization
        in: header
        description: OAuth authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_credentialing_v2_FacilityCredentialingSpan'
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - UnauthorizedError
                  content:
                    $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage'
                required:
                - errorName
                - content
        '422':
          description: Error response with status 422
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - HttpRequestValidationsError
                  content:
                    type: array
                    items:
                      $ref: '#/components/schemas/type_commons_RequestValidationError'
                required:
                - errorName
                - content
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                service_facility_id:
                  type: string
                  format: uuid
                  description: The ID of the service facility covered by the credentialing span.
                contracting_provider_id:
                  type: string
                  format: uuid
                  description: The ID of the billing provider for which the rendering provider is covered by the credentialing span.
                payer_uuid:
                  type: string
                  format: uuid
                  description: The ID of the payer covered by the credentialing span.
                start_date:
                  type: string
                  format: date
                  description: Start date of the credentialing span.
                end_date:
                  type: string
                  format: date
                  description: End date of the credentialing span.
                submitted_date:
                  type: string
                  format: date
                  description: Date that the credential paperwork was submitted.
                payer_loaded_date:
                  type: string
                  format: date
                  description: Date that the payer loaded the credentialing span into their system.
              required:
              - service_facility_id
              - contracting_provider_id
              - payer_uuid
    get:
      operationId: getAllFacilities
      summary: Get all facility credentialing spans
      tags:
      - v2
      parameters:
      - name: limit
        in: query
        description: Maximum number of entities per page, defaults to 100.
        required: false
        schema:
          type: integer
      - name: page_token
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons_PageToken'
      - name: payer_uuid
        in: query
        description: Filter by payer.
        required: false
        schema:
          type: string
          format: uuid
      - name: contracting_provider_id
        in: query
        description: Filter to a particular contracting provider.
        required: false
        schema:
          type: string
          format: uuid
      - name: service_facility_id
        in: query
        description: Filter to a particular service facility.
        required: false
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: OAuth authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_credentialing_v2_FacilityCredentialingSpanPage'
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - UnauthorizedError
                  content:
                    $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage'
                required:
                - errorName
                - content
        '422':
          description: Error response with status 422
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - UnprocessableEntityError
                  content:
                    $ref: '#/components/schemas/type_commons_UnprocessableEntityErrorMessage'
                required:
                - errorName
                - content
  /api/provider-credentialing-span/v2/facility/{facility_credentialing_id}:
    get:
      operationId: getFacility
      summary: Get facility credentialing span
      tags:
      - v2
      parameters:
      - name: facility_credentialing_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_credentialing_v2_FacilityCredentialingSpanId'
      - name: Authorization
        in: header
        description: OAuth authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_credentialing_v2_FacilityCredentialingSpan'
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - UnauthorizedError
                  content:
                    $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage'
                required:
                - errorName
                - content
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - EntityNotFoundError
                  content:
                    $ref: '#/components/schemas/type_commons_EntityNotFoundErrorMessage'
                required:
                - errorName
                - content
    delete:
      operationId: deleteFacility
      summary: Delete facility credentialing span
      description: Soft deletes a credentialing span rate from the system.
      tags:
      - v2
      parameters:
      - name: facility_credentialing_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_credentialing_v2_FacilityCredentialingSpanId'
      - name: Authorization
        in: header
        description: OAuth authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - UnauthorizedError
                  content:
                    $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage'
                required:
                - errorName
                - content
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - EntityNotFoundError
                  content:
                    $ref: '#/components/schemas/type_commons_EntityNotFoundErrorMessage'
                required:
                - errorName
                - content
    patch:
      operationId: updateFacility
      summary: Update facility credentialing span
      tags:
      - v2
      parameters:
      - name: facility_credentialing_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_credentialing_v2_FacilityCredentialingSpanId'
      - name: Authorization
        in: header
        description: OAuth authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_credentialing_v2_FacilityCredentialingSpan'
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - UnauthorizedError
                  content:
                    $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage'
                required:
                - errorName
                - content
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - EntityNotFoundError
                  content:
                    $ref: '#/components/schemas/type_commons_EntityNotFoundErrorMessage'
                required:
                - errorName
                - content
        '422':
          description: Error response with status 422
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - UnprocessableEntityError
                  content:
                    $ref: '#/components/schemas/type_commons_UnprocessableEntityErrorMessage'
                required:
                - errorName
                - content
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                contracting_provider_id:
                  type: string
                  format: uuid
                  description: The ID of the billing provider for which the rendering provider is covered by the credentialing span.
                payer_uuid:
                  type: string
                  format: uuid
                  description: The ID of the payer doing the credentialing.
                start_date:
                  type: string
                  format: date
                  description: Start date of the credentialing span.
                end_date:
                  type: string
                  format: date
                  description: End date of the credentialing span.
                submitted_date:
                  type: string
                  format: date
                  description: Date that the credential paperwork was submitted.
                payer_loaded_date:
                  type: string
                  format: date
                  description: Date that the payer loaded the credentialing span into their system.
              required:
              - contracting_provider_id
  /api/provider-credentialing-span/v2:
    post:
      operationId: create
      summary: Create provider credentialing span
      tags:
      - v2
      parameters:
      - name: Authorization
        in: header
        description: OAuth authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_credentialing_v2_ProviderCredentialingSpan'
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - UnauthorizedError
                  content:
                    $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage'
                required:
                - errorName
                - content
        '422':
          description: Error response with status 422
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - HttpRequestValidationsError
                  content:
                    type: array
                    items:
                      $ref: '#/components/schemas/type_commons_Re

# --- truncated at 32 KB (193 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/candid-health/refs/heads/main/openapi/candid-health-v2-api-openapi.yml