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

# Update insurance claims

> Resolves the location from the `X-Vendor-Request-Key` header (slot); no `location_id` in the path.

Sets the clearinghouse claim number on a claim. TeamCare stores it as `clearinghouse_claim_id`; PMS syncs never overwrite it.

Set this before posting a claim payment: `POST /locations/{location_id}/claim_payments` finds each claim by matching the Stedi `clearingHouseClaimNumber` to this value.

Only `clearinghouse_claim_id` can be changed. Send `null` or an empty string to clear it.

Requires an API key with **RCM enabled**. Keys without it receive `401` with `{"errors": "RCM is not enabled for this API key"}`; contact TeamCare support to enable it.



## OpenAPI

````yaml https://app.teamcaredental.com/openapi-vendors-v2.json patch /insurance_claims/{insurance_claim_id}
openapi: 3.1.0
info:
  title: TeamCare Vendor API (v2)
  version: 2.0.0
  description: >-
    Version 2 of the TeamCare Vendor API. HIPAA-compliant and opt-in.


    ## What changed from v1


    The data endpoints and response shapes are identical to v1 — **only how you
    address a location changes.** In v1 the location lived in every URL
    (`/locations/{location_id}/patients`). In v2 you request a **slot** for a
    location once, then send the returned `request_key` in the
    `X-Vendor-Request-Key` header; `location_id` is gone from the data routes.


    ## Request cycle


    1. `POST /auth/token` → JWT (unchanged from v1).

    2. `GET /organizations`, `GET /locations` → pick a `location_id`.

    3. `POST /locations/{location_id}/slots` → `{ request_key, expires_at }`.

    4. Call any data endpoint with header `X-Vendor-Request-Key: <request_key>`
    (no `location_id` in the path).


    ## Minimal changes to migrate


    - Point your base URL at `https://api.teamcaredental.com/api/v2/vendors` (v2
    is served from `api.teamcaredental.com`, not `app.teamcaredental.com`).

    - Call the slot endpoint **once per location**.

    - Drop `/locations/{location_id}` from your data paths and add the
    `X-Vendor-Request-Key` header.

    - Everything else — authentication, Ransack `q` filters, pagination,
    response shapes — is unchanged.


    ## Slot validity, cooldown & quota


    - **Validity:** a `request_key` is valid for **6 hours** — the same lifetime
    as the access token. After that it stops authorizing and you must request a
    new slot.

    - **Cooldown:** you can only re-request the **same** location's slot once
    every **2 minutes**. Within the cooldown the slot endpoint returns `429`
    with a `retry_after` (seconds).

    - **Quota:** each firm may hold up to its `concurrent_slots` quota (default
    **10**) active request keys at once, so data for at most 10 locations can be
    pulled concurrently. Requesting an 11th slot trims the oldest key, so its
    `request_key` stops authorizing immediately and any in-flight requests using
    it fail with `401`. To raise the quota above 10, contact TeamCare support.

    - **Rate limit:** the slot endpoint accepts at most 10 requests per 10
    seconds per token.


    ## Recommended usage


    Request a slot for a location and pull **all** of that location's data in
    one pass before moving on — don't re-request slots per call or churn between
    locations. If you fan out across locations in parallel, keep the fan-out at
    or below your quota: once an 11th slot is requested, the oldest
    `request_key` is invalidated even if a sync is still running on it.


    See the [changelog](https://docs.teamcaredental.com/changelog) for the full
    list of changes from v1.
servers:
  - url: https://api.teamcaredental.com/api/v2/vendors
security:
  - bearerAuth: []
paths:
  /insurance_claims/{insurance_claim_id}:
    patch:
      tags:
        - Insurance Claims
      summary: Update insurance claims
      description: >-
        Resolves the location from the `X-Vendor-Request-Key` header (slot); no
        `location_id` in the path.


        Sets the clearinghouse claim number on a claim. TeamCare stores it as
        `clearinghouse_claim_id`; PMS syncs never overwrite it.


        Set this before posting a claim payment: `POST
        /locations/{location_id}/claim_payments` finds each claim by matching
        the Stedi `clearingHouseClaimNumber` to this value.


        Only `clearinghouse_claim_id` can be changed. Send `null` or an empty
        string to clear it.


        Requires an API key with **RCM enabled**. Keys without it receive `401`
        with `{"errors": "RCM is not enabled for this API key"}`; contact
        TeamCare support to enable it.
      operationId: locations_resources_insurance_claims_update
      parameters:
        - name: insurance_claim_id
          in: path
          required: true
          description: >-
            The TeamCare ID of the insurance claim, from `GET
            /locations/{location_id}/insurance_claims`.
          schema:
            type: string
            example: '91422'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - insurance_claim
              properties:
                insurance_claim:
                  type: object
                  properties:
                    clearinghouse_claim_id:
                      type:
                        - string
                        - 'null'
                      example: CH-0098431
            example:
              insurance_claim:
                clearinghouse_claim_id: CH-0098431
      responses:
        '200':
          description: The updated claim.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      type:
                        type: string
                        example: insurance_claim
                      attributes:
                        type: object
                        properties:
                          deleted:
                            type: boolean
                          patient_id:
                            type: number
                          provider_id:
                            type: number
                          insurance_carrier_id:
                            type: number
                          insurance_carrier_name:
                            type:
                              - string
                              - 'null'
                            description: >-
                              Carrier name, joined from the claim's insurance
                              carrier. Null if the claim has no carrier or the
                              carrier has been deleted.
                          claim_type:
                            type: string
                            enum:
                              - preauthorization
                              - claim
                          insurance_type:
                            type: string
                            enum:
                              - primary
                              - secondary
                              - medical
                              - other
                          status:
                            type: string
                            enum:
                              - created
                              - sent
                              - received
                          claim_date:
                            type: string
                            format: date-time
                          total_amount:
                            type: number
                          sent_at:
                            type: string
                            format: date-time
                          estimated_insurance_payment:
                            type: number
                          received_at:
                            type: string
                            format: date-time
                          actual_insurance_payment:
                            type: number
                          service_date:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            description: Date of service of the claim.
                          claim_identifier:
                            type:
                              - string
                              - 'null'
                            description: >-
                              The PMS claim identifier sent on the claim (X12
                              CLM01). For Open Dental this is `ClaimIdentifier`,
                              `PatNum/ClaimNum` by default.
                          clearinghouse_claim_id:
                            type:
                              - string
                              - 'null'
                            description: >-
                              Clearinghouse claim number, set by the vendor with
                              `PATCH
                              /locations/{location_id}/insurance_claims/{insurance_claim_id}`.
                              Never overwritten by PMS syncs. Claim payments are
                              matched to claims by this value.
                          updated_at:
                            type: string
                            format: date-time
              example:
                data:
                  id: '91422'
                  type: insurance_claim
                  attributes:
                    deleted: false
                    patient_id: 48219
                    provider_id: 312
                    insurance_carrier_id: 1044
                    insurance_carrier_name: Delta Dental
                    claim_type: claim
                    insurance_type: primary
                    status: received
                    claim_date: '2026-08-14T00:00:00.000Z'
                    total_amount: 1240
                    sent_at: '2026-08-15T00:00:00.000Z'
                    estimated_insurance_payment: 812
                    received_at: '2026-08-29T00:00:00.000Z'
                    actual_insurance_payment: 790.5
                    service_date: '2026-08-14T00:00:00.000Z'
                    claim_identifier: 48219/91422
                    clearinghouse_claim_id: CH-0098431
                    updated_at: '2026-08-29T10:12:44.000Z'
        '401':
          description: >-
            Missing/invalid/expired JWT, or missing/invalid/expired
            X-Vendor-Request-Key.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: string
              examples:
                not_authorized:
                  value:
                    errors: not authorized
                rcm_not_enabled:
                  value:
                    errors: RCM is not enabled for this API key
        '403':
          description: The credential may not access this resource.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: string
              example:
                errors: access Denied
        '404':
          description: Resource not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: string
              example:
                errors: resource not found
        '422':
          description: The request could not be processed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: string
              example:
                errors: ...
      security:
        - bearerAuth: []
          vendorRequestKey: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT returned by POST /auth/token. Valid for six hours.
    vendorRequestKey:
      type: apiKey
      in: header
      name: X-Vendor-Request-Key
      description: >-
        Request key returned by POST /locations/{location_id}/slots. Identifies
        the practice for a data request; valid for 6 hours (the access token's
        lifetime) and subject to the firm's concurrent-slot quota.

````

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