Update a Pix key

​

Updates owner and/or account information associated with an existing Pix key in the DICT.

Path Parameters
  • key
    Type: string
    required

    Pix key value to update (CPF, CNPJ, phone, email, or EVP)

Headers
  • Idempotency-Key
    Type: string
    required

    Unique idempotency key for the request (UUID format)

Body·
required
application/json

Request to update a key link in DICT

  • reason
    Type: string enum
    required

    Reason for the key operation (creation, update, or deletion)

    values
    • USER_REQUESTED
    • RECONCILIATION
    • ACCOUNT_CLOSURE
    • BRANCH_TRANSFER
    • FRAUD
    • DEFAULT_OPERATION
    • RFB_VALIDATION
  • account
    Type: object ·

    Updated transactional account data for a Pix key update operation

  • owner
    Type: object ·

    Updated holder data for a Pix key update operation. All fields are optional.

Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for patch/api/v1/keys/{key}
curl 'http://localhost:8080/api/v1/keys/{key}' \
  --request PATCH \
  --header 'Idempotency-Key: ' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "owner": {
    "name": "",
    "tradeName": ""
  },
  "account": {
    "branch": "",
    "number": "",
    "type": "CACC",
    "openingDate": ""
  },
  "reason": "USER_REQUESTED"
}'

{
  "id": "string",
  "status": "ACTIVE",
  "keyType": "EVP",
  "key": "string",
  "owner": {
    "personType": "string",
    "taxId": "string",
    "name": "string",
    "tradeName": "string"
  },
  "account": {
    "ispb": "string",
    "type": "string",
    "branch": "string",
    "number": "string",
    "openingDate": "2026-07-29T19:28:46.731Z"
  },
  "reason": "USER_REQUESTED",
  "keyOwnershipDate": "2026-07-29T19:28:46.731Z",
  "createdAt": "2026-07-29T19:28:46.731Z",
  "updatedAt": "2026-07-29T19:28:46.731Z",
  "creationDate": "2026-07-29T19:28:46.731Z",
  "openClaimCreationDate": "2026-07-29T19:28:46.731Z",
  "endToEndId": "string",
  "ownerStatistics": {
    "spi": {
      "watermark": "2026-07-29T19:28:46.731Z",
      "settlements": {
        "d90": 1,
        "m12": 1,
        "m60": 1
      }
    },
    "fraudMarkers": {
      "watermark": "2026-07-29T19:28:46.731Z",
      "applicationFrauds": {
        "d90": 1,
        "m12": 1,
        "m60": 1
      },
      "muleAccounts": {
        "d90": 1,
        "m12": 1,
        "m60": 1
      },
      "scammerAccounts": {
        "d90": 1,
        "m12": 1,
        "m60": 1
      },
      "otherFrauds": {
        "d90": 1,
        "m12": 1,
        "m60": 1
      },
      "unknownFrauds": {
        "d90": 1,
        "m12": 1,
        "m60": 1
      },
      "totalFraudTransactionAmount": {
        "d90": 1,
        "m12": 1,
        "m60": 1
      },
      "distinctFraudReporters": {
        "d90": 1,
        "m12": 1,
        "m60": 1
      }
    },
    "infractionReports": {
      "watermark": "2026-07-29T19:28:46.731Z",
      "openReports": 1,
      "openReportsDistinctReporters": 1,
      "rejectedReports": {
        "d90": 1,
        "m12": 1,
        "m60": 1
      }
    },
    "entries": {
      "watermark": "2026-07-29T19:28:46.731Z",
      "registeredAccounts": 1
    }
  },
  "keyStatistics": {
    "spi": {
      "watermark": "2026-07-29T19:28:46.731Z",
      "settlements": {
        "d90": 1,
        "m12": 1,
        "m60": 1
      }
    },
    "fraudMarkers": {
      "watermark": "2026-07-29T19:28:46.731Z",
      "applicationFrauds": {
        "d90": 1,
        "m12": 1,
        "m60": 1
      },
      "muleAccounts": {
        "d90": 1,
        "m12": 1,
        "m60": 1
      },
      "scammerAccounts": {
        "d90": 1,
        "m12": 1,
        "m60": 1
      },
      "otherFrauds": {
        "d90": 1,
        "m12": 1,
        "m60": 1
      },
      "unknownFrauds": {
        "d90": 1,
        "m12": 1,
        "m60": 1
      },
      "totalFraudTransactionAmount": {
        "d90": 1,
        "m12": 1,
        "m60": 1
      },
      "distinctFraudReporters": {
        "d90": 1,
        "m12": 1,
        "m60": 1
      }
    },
    "infractionReports": {
      "watermark": "2026-07-29T19:28:46.731Z",
      "openReports": 1,
      "openReportsDistinctReporters": 1,
      "rejectedReports": {
        "d90": 1,
        "m12": 1,
        "m60": 1
      }
    },
    "entries": {
      "watermark": "2026-07-29T19:28:46.731Z",
      "distinctAccounts": {
        "d90": 1,
        "m12": 1,
        "m60": 1
      }
    }
  }
}

Pix key updated successfully.