Skip to main content

Get Pix Key by ID

GET 
/pix/keys/:id

Retrieve the state and detailed information of a pix key by specifying its ID. Canceled keys are not returned; instead, a 422 error will be sent.

Request​

Path Parameters

    id stringrequired

    Pix Key ID.

Header Parameters

    nonce stringrequired

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

Responses​

The pix key returned successfully. Returns null if key id is not found.

Schema
    id stringrequired

    Pix Key ID.

    key stringrequired

    Pix key.

    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.

    state stringrequired

    Possible values: [PENDING, CONFIRMED, NOT_CONFIRMED, ADD_KEY_READY, READY, CANCELED, ERROR, DELETING, DELETED, DELETED_ERROR, PORTABILITY_PENDING, PORTABILITY_OPENED, PORTABILITY_STARTED, PORTABILITY_READY, PORTABILITY_CONFIRMED, PORTABILITY_CANCELING, PORTABILITY_CANCELED, PORTABILITY_REQUEST_PENDING, PORTABILITY_REQUEST_CANCEL_OPENED, PORTABILITY_REQUEST_CANCEL_STARTED, PORTABILITY_REQUEST_CONFIRM_OPENED, PORTABILITY_REQUEST_CONFIRM_STARTED, PORTABILITY_REQUEST_AUTO_CONFIRMED, OWNERSHIP_PENDING, OWNERSHIP_OPENED, OWNERSHIP_STARTED, OWNERSHIP_CONFIRMED, OWNERSHIP_READY, OWNERSHIP_CANCELING, OWNERSHIP_CANCELED, OWNERSHIP_WAITING, OWNERSHIP_CONFLICT, CLAIM_NOT_CONFIRMED, CLAIM_PENDING, CLAIM_CLOSING, CLAIM_DENIED, CLAIM_CLOSED, CLAIM_READY]

    Pix Key state:

    • PENDING: Key state PENDING.
    • CONFIRMED: Key state CONFIRMED.
    • NOT_CONFIRMED: Key state NOT_CONFIRMED.
    • ADD_KEY_READY: Key state ADD_KEY_READY.
    • READY: Key state READY.
    • CANCELED: Key state CANCELED.
    • ERROR: Key state ERROR.
    • DELETING: Key state DELETING.
    • DELETED: Key state DELETED.
    • PORTABILITY_PENDING: Key state PORTABILITY_PENDING.
    • PORTABILITY_OPENED: Key state PORTABILITY_OPENED.
    • PORTABILITY_STARTED: Key state PORTABILITY_STARTED.
    • PORTABILITY_READY: Key state PORTABILITY_READY.
    • PORTABILITY_CONFIRMED: Key state PORTABILITY_CONFIRMED.
    • PORTABILITY_CANCELED: Key state PORTABILITY_CANCELED.
    • PORTABILITY_REQUEST_PENDING: Key state PORTABILITY_REQUEST_PENDING.
    • PORTABILITY_REQUEST_CANCEL_OPENED: Key state PORTABILITY_REQUEST_CANCEL_OPENED.
    • PORTABILITY_REQUEST_CANCEL_STARTED: Key state PORTABILITY_REQUEST_CANCEL_STARTED.
    • PORTABILITY_REQUEST_CONFIRM_OPENED: Key state PORTABILITY_REQUEST_CONFIRM_OPENED.
    • PORTABILITY_REQUEST_CONFIRM_STARTED: Key state PORTABILITY_REQUEST_CONFIRM_STARTED.
    • PORTABILITY_REQUEST_AUTO_CONFIRMED: Key state PORTABILITY_REQUEST_AUTO_CONFIRMED.
    • OWNERSHIP_PENDING: Key state OWNERSHIP_PENDING.
    • OWNERSHIP_OPENED: Key state OWNERSHIP_OPENED.
    • OWNERSHIP_STARTED: Key state OWNERSHIP_STARTED.
    • OWNERSHIP_CONFIRMED: Key state OWNERSHIP_CONFIRMED.
    • OWNERSHIP_READY: Key state OWNERSHIP_READY.
    • OWNERSHIP_CANCELED: Key state OWNERSHIP_CANCELED.
    • OWNERSHIP_CONFLICT: Key state OWNERSHIP_CONFLICT.
    • OWNERSHIP_WAITING: Key state OWNERSHIP_WAITING.
    • CLAIM_NOT_CONFIRMED: Key state CLAIM_NOT_CONFIRMED.
    • CLAIM_PENDING: Key state CLAIM_PENDING.
    • CLAIM_CLOSING: Key state CLAIM_CLOSING.
    • CLAIM_DENIED: Key state CLAIM_DENIED.
    • CLAIM_CLOSED: Key state CLAIM_CLOSED.

    created_at date-timerequired

    Pix Key created at.

    failed_message stringrequired

    Pix Key failed message.

Loading...