Register a new Pix key

​

Registers a new Pix key in the DICT (Directory of Transactional Account Identifiers). For EVP key type, the key value is generated automatically.

Headers
  • Idempotency-Key
    Type: string
    required

    Unique idempotency key for the request (UUID format)

Body
required
application/json
    • Type: object ·
      • account
        Type: object ·
        required

        Linked transactional account

      • key
        Type: string
        min length:  
        1
        required

        CNPJ: 14 alphanumeric characters (digits or uppercase letters)

      • keyType
        Type: string
        required
      • owner
        Type: object ·
        required

        Holder data

      • 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
      • requestId
        Type: string Format: uuid

        Request identifier used as HMAC key for CID calculation

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

{
  "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.545Z"
  },
  "reason": "USER_REQUESTED",
  "keyOwnershipDate": "2026-07-29T19:28:46.545Z",
  "createdAt": "2026-07-29T19:28:46.545Z",
  "updatedAt": "2026-07-29T19:28:46.545Z",
  "creationDate": "2026-07-29T19:28:46.545Z",
  "openClaimCreationDate": "2026-07-29T19:28:46.545Z",
  "endToEndId": "string",
  "ownerStatistics": {
    "spi": {
      "watermark": "2026-07-29T19:28:46.545Z",
      "settlements": {
        "d90": 1,
        "m12": 1,
        "m60": 1
      }
    },
    "fraudMarkers": {
      "watermark": "2026-07-29T19:28:46.545Z",
      "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.545Z",
      "openReports": 1,
      "openReportsDistinctReporters": 1,
      "rejectedReports": {
        "d90": 1,
        "m12": 1,
        "m60": 1
      }
    },
    "entries": {
      "watermark": "2026-07-29T19:28:46.545Z",
      "registeredAccounts": 1
    }
  },
  "keyStatistics": {
    "spi": {
      "watermark": "2026-07-29T19:28:46.545Z",
      "settlements": {
        "d90": 1,
        "m12": 1,
        "m60": 1
      }
    },
    "fraudMarkers": {
      "watermark": "2026-07-29T19:28:46.545Z",
      "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.545Z",
      "openReports": 1,
      "openReportsDistinctReporters": 1,
      "rejectedReports": {
        "d90": 1,
        "m12": 1,
        "m60": 1
      }
    },
    "entries": {
      "watermark": "2026-07-29T19:28:46.545Z",
      "distinctAccounts": {
        "d90": 1,
        "m12": 1,
        "m60": 1
      }
    }
  }
}

Pix key registered successfully.