PortabilityClaimResponse

Portability claim response

  • acknowledgedAt
    Type: string Format: date-time

    Date and time the claim was acknowledged

  • cancelledAt
    Type: string Format: date-time

    Date and time the claim was cancelled

  • cancelledBy
    Type: string enum

    Party that cancelled the claim (present only if the claim was cancelled)

    values
    • DONOR
    • CLAIMER
    • SYSTEM
  • cancelReason
    Type: string enum

    Reason for cancellation (present only if the claim was cancelled)

    values
    • USER_REQUESTED
    • ACCOUNT_CLOSURE
    • FRAUD
    • DEFAULT_OPERATION
    • RECONCILIATION
    • RFB_VALIDATION
  • claimer
    Type: object · ClaimerDataResponse

    Claimant identification 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) of the claimant

    • tradeName
      Type: string

      Trade name (only applicable for Legal Person)

  • claimerAccount
    Type: object · ClaimerAccountDataResponse

    Claimant account information in response

    • accountNumber
      Type: string

      Account number at the claimer institution

    • accountType
      Type: string

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

    • branch
      Type: string

      Branch number without check digit (4 digits)

    • openingDate
      Type: string

      Account opening date (ISO 8601 format)

    • participant
      Type: string

      ISPB of the claimer institution (8 numeric digits)

  • claimerParticipant
    Type: string

    ISPB of the claimer (requesting) institution

  • closingPeriodEnd
    Type: string Format: date-time

    Deadline for closing the ownership claim (OWNERSHIP type only)

  • completedAt
    Type: string Format: date-time

    Date and time the claim was completed

  • completedBy
    Type: string enum

    Party that completed the claim (present only if the claim was completed)

    values
    • CLAIMER
    • SYSTEM
  • completionPeriodEnd
    Type: string Format: date-time

    Deadline for the claimer to complete the claim after confirmation

  • confirmedAt
    Type: string Format: date-time

    Date and time the claim was confirmed

  • confirmedBy
    Type: string enum

    Party that confirmed the claim (present only if the claim was confirmed)

    values
    • DONOR
    • SYSTEM
  • dictClaimId
    Type: string Format: uuid

    Claim identifier in DICT

  • donorParticipant
    Type: string

    ISPB of the donor (current holder) institution

  • expiresAt
    Type: string Format: date-time

    Expiration date of the claim (OWNERSHIP type only)

  • id
    Type: string Format: uuid

    Internal claim identifier in PSTI

  • isClaimer
    Type: boolean

    Indicates whether the requesting participant is the claimer institution

  • isDonor
    Type: boolean

    Indicates whether the requesting participant is the donor institution

  • key
    Type: string

    Pix key value being claimed

  • keyType
    Type: string enum

    Type of the Pix key being claimed

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

    Date and time of the last status change

  • requestedAt
    Type: string Format: date-time

    Date and time the claim was opened in DICT (request date)

  • resolutionPeriodEnd
    Type: string Format: date-time

    Deadline for the donor to confirm or cancel the claim

  • status
    Type: string enum

    Current status of the claim

    values
    • OPEN
    • WAITING_RESOLUTION
    • CONFIRMED
    • CANCELLED
    • COMPLETED
  • type
    Type: string enum

    Claim type: PORTABILITY or OWNERSHIP

    values
    • PORTABILITY
    • OWNERSHIP