Creating Bre-B Keys

Overview

Bre-B is Colombia’s immediate payment system (Sistema de Pagos Inmediatos - SPI), enabling real-time transfers between individuals, businesses, and financial entities. At the heart of this system lies Key Management, it revolves on the unique identifier to simplify payments.

Core Concepts

In Bre-B, a Key (or “alias”) serves as a simplified, human-readable identifier for a user’s bank account. Instead of sharing long account numbers, users register a key that can be used to send or receive payments instantly.

Each key is mapped to a specific account and must be globally unique within the Bre-B ecosystem.

The relationship type between an account and key is 1:M, which means an account may have one or more keys associated.

Business Value

Bre-B key management provides a standardized, interoperable layer that benefits all participants in the financial ecosystem:

For Entities

  • Enhances customer experience and adoption through easier onboarding and simplified transfers.
  • Increases operational efficiency with lower errors.

For Users

  • Enables real-time payments using simple identifiers.
  • Avoids errors related to entering long account numbers.
  • Makes payment experiences more intuitive, ideal for mobile-first scenarios.

For Regulators

  • Promotes financial inclusion and broader access to digital payments.
  • Provides centralized traceability of key ownership and transfers.
  • Aligns with regional interoperability goals across Latin America.

Benefits of Key-Based Transfers

BenefitDescription
Simplified UXCustomers initiate transfers with one of the supported Key Types, not an account number.
Speed & ReliabilityPayments occur in real time, with instant confirmation.
InteroperabilityKeys are usable across participating banks and entities.
Security & PrivacyMinimizes the exposure of sensitive financial data.
Multiple Keys per AccountA single account may have multiple identifiers.

Example of Use Cases

Peer-to-Peer (P2P) Transfers

A customer sends money to a friend using their email address or cellphone. No need to ask for or store account details.

Person-to-Merchant (P2M) Payments

A small merchant registers a key (tiendaelalcalde@correo.com) and receives instant customer payments directly into their business account.

Key Lifecycle

  1. Create a Key: Map a key_value to an account (account_id) with the Create Keys endpoint.
  2. Update a Key: Change the associated account (e.g., if the user switches financial entities).
  3. Suspend a Key: Block key temporarily for security reasons.
  4. Delete a Key: Unlink the key from the associated customer account.
  5. Resolve a Key: Search the registry to resolve keys into accounts.

Create a Key

For more information about the endpoint details, please refer to Create Keys page.

Key Types and Key Value

The key_type field defines the format and purpose of the key used to identify a bank deposit account within the Bre-B system. These keys reduce friction, enabling fast, secure payments between customers (Individual and Business), across financial entities, without the need for traditional account information.

Key Type (Code)DescriptionKey Value
NRICDocument Number7922089
MMobile Phone Number+573001234567
EEmailuser@example.com
OCustom Alias@client_alias_123
BEntity Commercial Code0012345678

The combination of key_type and key_value must be unique across the entire Bre-B infrastructure.

Request Example

ParameterDescription
account_idID of the account to link the key to.
key_typeType of key. see 'Key Types and Key Value' section above for valid values.
key_valueUnique identifier for the key. Must match the format of the given type.

The account_id relates to the ID generated in the Link Account endpoint. You may refer to the Product Guide Customer Onboarding, to review the Onboarding process.

Request Body

JSON
Copy

Response Example

ParameterDescription
idUnique ID of the key in the system.
key_valueThe value registered for this key.
account_idThe account this key is linked to.
key_typeThe type of key created (e.g., E for email).

Response Body

JSON
Copy

Support and Resources

  • Visit the Postman Collection for practical examples.
  • Contact your Passport representative or technical support for further guidance.
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard