Skip to main content

Create Pix Key

POST 
/v2/pix/keys
Tag: api-paas-post-pix-keysDescription: Add a new key for the user. Allowed key types:
  • CPF: Creates a new key based on the document available in the user profile.
  • EMAIL: Creates a new key associated with an arbitrary email. An email will be sent with a 5-digit code to validate it.
  • PHONE: Creates a new key associated with an arbitrary phone number. An SMS will be sent with a 5-digit code to validate it.
  • EVP: Creates a random key.
  • CNPJ: Creates a new key based on the document available in the user profile.
Returns the created key with a state of PENDING (for types PHONE or EMAIL) or CONFIRMED (for types CPF or EVP).PS: The mobile app should call GET /pix/keys/id/code to send a code (e-mail or SMS) to the user.

Request​

Header Parameters

    x-transaction-uuid stringrequired

    The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.

    x-wallet-uuid string

    Sender Wallet UUID (if empty, your default Wallet UUID will be settled)

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

    x-product-uuid string

    The product ID is a UUID (v4) used to identify the Z.ro product configuration.

    x-product-target-user-uuid string

    The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.

Body

required
    type stringrequired

    Possible values: [CNPJ, CPF, PHONE, EMAIL, EVP]

    Pix Key state:

    • CPF: Key type CPF.
    • EVP: Key type EVP.
    • EMAIL: Key type EMAIL.
    • PHONE: Key type PHONE.
    • CNPJ: Key type CNPJ.

    key string

    Pix key.

Responses​

The pix key returned successfully.

Schema
    id stringrequired

    Pix Key ID.

    key stringrequired

    Pix Key.

    type objectrequired

    Pix Key Type.

    state objectrequired

    Pix Key State.

    created_at date-timerequired

    Pix Key Created At.

Loading...