Customer Onboarding

Overview

This guide helps you understand how to digitally onboard new customers and link financial accounts for them using Passport PaaS platform. This simple and effective process lets your entity quickly register customers, link accounts, and set them up for easy and secure payments. By completing these steps, your customers will be ready for payments and key creation through our Bre-B infrastructure.

We are currently enhancing our onboarding process (KYB – Know Your Business). Soon, additional business details may be required. For now, the Sandbox environment remains straightforward and provides the Customer ID needed to continue testing.

This process reflects what will happen in the Sandbox environment, although some parts are still being finalized. In Production, customer onboarding will include additional requirements such as anti-money laundering (AML) declarations and supporting documents. These details are not yet implemented in the Sandbox and Production.

If you manage payments under your business (especially if you hold a Payments License), ensure the customer details entered here match your manually registered business information. Think of this step as digitally registering your own business, setting you up to manage your accounts at the Sponsor Bank.

Business Value

Accelerate customer registration, enabling quicker access to financial services.
Reduce manual paperwork and errors, improving operational efficiency.
Create a seamless customer experience by rapidly onboarding users digitally.

Onboard Your Customer

Request Details (Business)

Business: Request Example

For more details of the endpoint, please refer to the document: Create Customer

Parameter	Description
type	Choose `BUSINESS` (company)
business_name	Enter the registered legal name of your customer’s business.
mobile_phone_number	Provide the mobile phone number in Colombia format (including country code +57).
identification_type	Specify the type of identification document (NIT).
identification_number	Input the official NIT number from the company.

Business: Request Body

Business
    
xxxxxxxxxx
 
curl --location 'https://bre-b-sandbox.api.visionamos.passportfintech.com/v1/paas/entities/customers' \--header 'Content-Type: application/json' \--header 'Authorization: YOUR_ACCESS_TOKEN' \--data-raw '{    "type": "BUSINESS",    "business_name": "Test Business E0C0M",    "email": "Woym8v4H@example.com",    "mobile_phone_number": "+573331115443",    "identification_type": "NIT",    "identification_number": "253499214"}'
Copy

Business: Response Example

Parameter	Description
id	A unique identifier assigned to this business customer. You'll use it to link an account in the next step.
type	Confirms the customer is registered as a `BUSINESS`.
business_name	The official name of the business.
email	Business email used for communication and verification.
mobile_phone_number	Stored contact number of the business.
identification_type	The type of ID provided (NIT).
identification_number	The NIT number of the business.

Business: Response Body

Business
    
xxxxxxxxxx
 
{    "identification_number": "253499214",    "type": "BUSINESS",    "id": "5ae28bc6-49e1-4710-a2d9-7b2f0f488ecb",    "email": "Woym8v4H@example.com",    "business_name": "Test Business E0C0M",    "mobile_phone_number": "573331115443",    "identification_type": "NIT"}
Copy

Now that your customer has been successfully registered, you're ready to link a bank account for them. The Customer ID returned in the previous step is essential for this.

Customers cannot transact until they have an account, so this step is key to unlocking access to the platform's financial services, including real-time payments.

Link a Bank Account

With the Customer ID generated and the processes of linking a bank account has been completed, now the link step between the objects can be done. Business customers can only have accounts with the following type:

ORDINARY: Best for businesses, with no set transaction limits.

A customer may have multiple bank accounts, in a 1:M relationship.

Business Value

Offer tailored account options based on customer financial needs.
Enable immediate use of financial services through instantly available accounts.

Request Example

Use the Customer ID obtained in either Business or Individual example.

Parameter	Description
entity_customer_id	Unique ID from the Customer Creation response body.
type	The Account Type: `ORDINARY`

Request Body

Account
    
 
curl --location 'https://bre-b-sandbox.api.visionamos.passportfintech.com/v1/paas/entities/customers/accounts' \--header 'Content-Type: application/json' \--header 'Authorization: ••••••' \--data '{    "entity_customer_id": "5ae28bc6-49e1-4710-a2d9-7b2f0f488ecb",    "type": "ORDINARY"}'
Copy

Response Example

Parameter	Description
entity_customer_id	The ID of the customer the account is linked to.
available_balance	The object that contains the amount and currency information of the available balance of the account.
available_balance.currency	The currency type of the account (COP - Colombian Peso).
available_balance.value	The monetary value of money currently available in the account.
id	The unique ID of the newly created account. You'll use this for transactions and key creation.
number	The internal number assigned to the account, this acts as the account identifier within the sponsor bank.
type	Indicates the account type: `ORDINARY` (no transaction limits).
pending_balance	The object that contains the pending amounts and currency information of the transactions that were not liquidated.
pending_balance.currency	The currency type of the account (COP - Colombian Peso).
pending_balance.value	The monetary value of money in pending status for the account.

The notation object.parameter relates to the object and parameter relationship, within the request or response, in the example given. pending_balance.currency, refers to the currency parameter within the pending_balance object.

Next Steps

After setting up your customer's account, proceed to Creating Bre-B Keys to interact with the Bre-B infrastructure and this enables making instant secure payments easy.

Support and Resources

Visit the Postman Collection for practical examples.
Contact your Passport representative or technical support for further guidance.

Last updated on