EntryResponse

Pix key entry details returned after creation, update, deletion, or retrieval

  • account
    Type: object · AccountResponse

    Linked transactional account information in response

    • branch
      Type: string

      Branch number without check digit (4 digits)

    • ispb
      Type: string

      ISPB of the institution (8 numeric digits)

    • number
      Type: string

      Account number

    • openingDate
      Type: string Format: date-time

      Account opening date

    • type
      Type: string

      Account type: CACC (current), TRAN (transacting), SLRY (salary), SVGS (savings)

  • createdAt
    Type: string Format: date-time

    Date when this record was created in PSTI

  • creationDate
    Type: string Format: date-time

    Date when the Pix key was originally created in DICT

  • endToEndId
    Type: string

    End-to-end identifier generated for this DICT lookup

  • id
    Type: string

    Internal identifier of the Pix key entry in PSTI

  • key
    Type: string

    Pix key value (may be normalized)

  • keyOwnershipDate
    Type: string Format: date-time

    Date when the current owner took ownership of the key

  • keyStatistics
    Type: object · KeyStatisticsDTO
    • entries
      Type: object · KeyEntriesStatisticsDTO
    • fraudMarkers
      Type: object · FraudMarkersDTO
    • infractionReports
      Type: object · InfractionReportsDTO
    • spi
      Type: object · SpiStatisticsDTO
  • keyType
    Type: string enum

    Type of the Pix key

    values
    • EVP
    • CPF
    • CNPJ
    • PHONE
    • EMAIL
  • openClaimCreationDate
    Type: string Format: date-time

    Date when an open portability/ownership claim was created for this key

  • owner
    Type: object · OwnerResponse

    Key holder (owner) information in response

    • name
      Type: string

      Full name (Natural Person) or legal name (Legal Person)

    • personType
      Type: string

      Person type: NATURAL_PERSON or LEGAL_PERSON

    • taxId
      Type: string

      CPF (11 digits) or CNPJ (14 digits)

    • tradeName
      Type: string

      Trade name (only applicable for Legal Person)

  • ownerStatistics
    Type: object · OwnerStatisticsDTO

    Statistics about the key owner (returned when includeStatistics=true)

    • entries
      Type: object · EntriesStatisticsDTO
    • fraudMarkers
      Type: object · FraudMarkersDTO
    • infractionReports
      Type: object · InfractionReportsDTO
    • spi
      Type: object · SpiStatisticsDTO
  • reason
    Type: string enum

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

    values
    • USER_REQUESTED
    • RECONCILIATION
    • ACCOUNT_CLOSURE
    • BRANCH_TRANSFER
    • FRAUD
    • DEFAULT_OPERATION
    • RFB_VALIDATION
  • status
    Type: string enum

    Current status of the Pix key entry

    values
    • ACTIVE
    • INACTIVE
    • OPEN
    • WAITING_RESOLUTION
    • CONFIRMED
    • CANCELLED
    • COMPLETED
  • updatedAt
    Type: string Format: date-time

    Date of the last update to this record in PSTI