CreatePortabilityClaimRequest

Request to create a portability claim

  • claimer
    Type: object · Claimer
    required

    Claimant (new key holder) identification information

    • name
      Type: string
      min length:  
      1
      required

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

    • personType
      Type: string enum
      required

      Type of person (holder)

      values
      • NATURAL_PERSON
      • LEGAL_PERSON
    • taxId
      Type: string
      min length:  
      1
      required

      CPF (11 digits) for NATURAL_PERSON, or CNPJ (14 alphanumeric characters) for LEGAL_PERSON

    • tradeName
      Type: string

      Trade name (only applicable for LEGAL_PERSON)

  • claimerAccount
    Type: object · ClaimerAccount
    required

    Claimant institution account information

    • openingDate
      Type: string
      min length:  
      1
      required

      Account opening date (ISO 8601 format)

    • participant
      Type: string
      min length:  
      1
      required

      ISPB of the claimer institution (8 numeric digits)

    • accountNumber
      Type: string

      Account number at the claimer institution

    • accountType
      Type: string enum

      Type of transactional account

      values
      • CACC
      • TRAN
      • SLRY
      • SVGS
    • branch
      Type: string

      Branch number without check digit (4 digits)

  • key
    Type: string
    min length:  
    1
    required

    Pix key value being claimed

  • keyType
    Type: string enum
    required

    Type of the Pix key being claimed

    values
    • EVP
    • CPF
    • CNPJ
    • PHONE
    • EMAIL
  • type
    Type: string enum
    required

    Claim type: PORTABILITY (same owner, different institution) or OWNERSHIP (different owner)

    values
    • PORTABILITY
    • OWNERSHIP