Skip to main content
GET
List all PIX keys

Authorizations

x-api-key
string
header
required

Company API key for authentication

Response

List of Pix keys

id
string
required

Pix key unique identifier

Example:

"a3dbd0c2-9f79-4f86-8caa-47779b3f2793"

affiliation_id
string
required

Affiliation ID associated with this PIX key

Example:

"a3dbd0c2-9f79-4f86-8caa-47779b3f2794"

company_id
string
required

Company ID that owns this PIX key

Example:

"a3dbd0c2-9f79-4f86-8caa-47779b3f2793"

key_type
enum<string>
required

The Pix key type

Available options:
EVP
Example:

"EVP"

key
string | null
required

The Pix key value (null for EVP keys before activation)

primary
boolean
required

Whether this is the primary PIX key for the company

Example:

true

status
enum<string>
required

The current status of the PIX key:

  • ACTIVE: Key is active and can be used
  • INACTIVE: Key is inactive
  • PENDING_DELETION: Key is marked for deletion
  • DELETED: Key has been deleted
Available options:
ACTIVE,
INACTIVE,
PENDING_DELETION,
DELETED
Example:

"ACTIVE"