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

# Cancel a Key Claim

> Use this endpoint to cancel a portability or ownership claim.



## OpenAPI

````yaml /pt/openapi/v3-current/indirect-pix.yaml post /v1/dict/claims/{claim_id}/cancel
openapi: 3.1.0
info:
  description: >-
    API for Pix Indirect via BTG. It covers DICT keys and claims; MED infraction
    reports, fraud markers, refund requests, and funds recoveries; DICT
    statistics and reconciliation; Pix transfers, refunds, and schedules; static
    QR codes and QR code decoding; immediate and due-date collections; Pix
    Automático for the payer; transaction reports and TemposTransacoes
    statistics; and inbound and outbound webhook records.
  title: Pix BTG API
  version: 1.12.0
servers:
  - url: https://api.example.com
    description: >-
      Replace the example host with the URL provided during environment
      onboarding.
security:
  - BearerAuth: []
paths:
  /v1/dict/claims/{claim_id}/cancel:
    post:
      tags:
        - Claims
      summary: Cancel a Key Claim
      description: Use this endpoint to cancel a portability or ownership claim.
      operationId: dict-cancel-claim
      parameters:
        - description: Claim ID (UUID)
          in: path
          name: claim_id
          required: true
          schema:
            description: Claim ID (UUID)
            format: uuid
            type: string
        - description: Account ID (UUID format)
          in: header
          name: X-Account-Id
          required: true
          schema:
            description: Account ID (UUID format)
            format: uuid
            type: string
        - description: >-
            Reason for cancellation: USER_REQUESTED, ACCOUNT_CLOSURE,
            DEFAULT_OPERATION, FRAUD, RECONCILIATION, COURT_ORDER (donor only)
          in: header
          name: X-Reason
          required: true
          schema:
            description: >-
              Reason for cancellation: USER_REQUESTED, ACCOUNT_CLOSURE,
              DEFAULT_OPERATION, FRAUD, RECONCILIATION, COURT_ORDER (donor only)
            enum:
              - USER_REQUESTED
              - ACCOUNT_CLOSURE
              - DEFAULT_OPERATION
              - FRAUD
              - RECONCILIATION
              - COURT_ORDER
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelClaimOutput'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Bad Request
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Internal Server Error
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Error
components:
  schemas:
    CancelClaimOutput:
      additionalProperties: false
      properties:
        accountId:
          description: Unique identifier of the account associated with this claim
          examples:
            - 550e8400-e29b-41d4-a716-446655440002
          type: string
        bacenClaimId:
          description: BACEN DICT identifier for this claim
          examples:
            - cc91b1b0-8465-44b1-a760-15dd3717ea9b
          type: string
        cancelReason:
          description: Reason for cancellation
          examples:
            - FRAUD
          type: string
        cancelledBy:
          description: Who cancelled the claim (DONOR or CLAIMER)
          examples:
            - DONOR
          type: string
        claimer:
          $ref: '#/components/schemas/Claimer'
          description: Account owner information
        claimerAccount:
          $ref: '#/components/schemas/ClaimerAccount'
          description: Account information of the claimer
        completedAt:
          description: Timestamp when the claim was completed (ISO 8601 UTC)
          examples:
            - '2020-08-31T13:48:55.970Z'
          format: date-time
          type: string
        completionPeriodEnd:
          description: Deadline for claim completion - D+14 from creation (ISO 8601 UTC)
          examples:
            - '2020-09-14T13:48:55.970Z'
          format: date-time
          type: string
        confirmReason:
          description: Reason the claim was confirmed
          examples:
            - DEFAULT_OPERATION
          type: string
        createdAt:
          description: Timestamp when the claim was created (ISO 8601 UTC)
          examples:
            - '2020-08-17T13:48:36Z'
          format: date-time
          type: string
        donorParticipant:
          description: ISPB of the donor PSP (current key holder)
          examples:
            - '30306294'
          type: string
        holderId:
          description: UUID of the account holder (claimer)
          examples:
            - 550e8400-e29b-41d4-a716-446655440001
          type: string
        id:
          description: Internal UUID of the claim
          examples:
            - 550e8400-e29b-41d4-a716-446655440000
          type: string
        key:
          description: The PIX key value (phone, email, CPF, CNPJ, or EVP)
          examples:
            - '+5561988887777'
          type: string
        keyType:
          description: Type of PIX key
          examples:
            - PHONE
          type: string
        resolutionPeriodEnd:
          description: Deadline for donor response - D+7 from creation (ISO 8601 UTC)
          examples:
            - '2020-08-31T13:48:55.970Z'
          format: date-time
          type: string
        status:
          description: Current status of the claim
          examples:
            - CANCELLED
          type: string
        type:
          description: Type of claim (OWNERSHIP or PORTABILITY)
          examples:
            - OWNERSHIP
          type: string
        updatedAt:
          description: Timestamp when the claim was last updated (ISO 8601 UTC)
          examples:
            - '2024-01-20T14:45:00Z'
          format: date-time
          type: string
      required:
        - id
        - accountId
        - bacenClaimId
        - holderId
        - status
        - type
        - key
        - keyType
        - claimer
        - claimerAccount
        - donorParticipant
        - confirmReason
        - cancelReason
        - cancelledBy
        - completedAt
        - resolutionPeriodEnd
        - completionPeriodEnd
        - createdAt
        - updatedAt
      type: object
    LegacyErrorBody:
      additionalProperties: false
      properties:
        fields:
          additionalProperties:
            type: string
          type: object
        headers:
          additionalProperties:
            type: string
          type: object
        message:
          type: string
        paths:
          additionalProperties:
            type: string
          type: object
        queryParams:
          additionalProperties:
            type: string
          type: object
        raw:
          type: string
        code:
          type: string
        title:
          type: string
      required:
        - code
        - title
        - message
      type: object
    Claimer:
      additionalProperties: false
      properties:
        document:
          description: Identification document of the account owner (CPF or CNPJ)
          examples:
            - '52998224725'
          type: string
        name:
          description: Full name or legal name of the account owner
          examples:
            - Antonio Jose Raimundo
          type: string
        type:
          description: Whether the account owner is a person or organization
          enum:
            - NATURAL_PERSON
            - LEGAL_PERSON
          examples:
            - NATURAL_PERSON
          type: string
      required:
        - document
        - name
        - type
      type: object
    ClaimerAccount:
      additionalProperties: false
      properties:
        branch:
          description: Bank branch code where the account is held (4 digits)
          examples:
            - '0001'
          type: string
        number:
          description: >-
            Unique account number at the institution, as sent to DICT: 1-20
            uppercase letters or digits, ending in a digit
          examples:
            - '2227654330'
          type: string
        openingDate:
          description: Date when the account was opened (ISO 8601 UTC)
          examples:
            - '2020-08-17T13:48:36Z'
          format: date-time
          type: string
        participant:
          description: >-
            ISPB of the participant institution (8 uppercase alphanumeric
            characters)
          examples:
            - '30306294'
          type: string
        type:
          description: Type of account holding the Pix key
          enum:
            - CACC
            - SVGS
            - TRAN
            - OTHR
          examples:
            - TRAN
          type: string
      required:
        - branch
        - number
        - openingDate
        - participant
        - type
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````

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