Create Customer
Overview
This endpoint provisions a new Customer resource on the Passport PaaS platform by linking it to an existing Merchant that was manually onboarded and approved by the Sponsor Bank. It supports BUSINESS customer types. Upon success, it returns the newly created customer’s unique identifier, contact details, identification metadata, In future iterations, full digital onboarding workflows will replace the manual Sponsor Bank approval process.
Our Compliance team helps you create the business profile and account(s) with the Sponsor Bank.
Endpoint Details
| Definition | Description |
|---|---|
| Endpoint | https://bre-b-sandbox.api.visionamos.passportfintech.com/v1/paas/entities/customers |
| Method | POST |
| Headers | Content-Type: application/json, Authorization |
| Authentication | Access Token (Bearer Token) |
Request Body
| Parameter | Type | Constraints | Required | Description |
|---|---|---|---|---|
| type | String | ENUM:
BUSINESS | Yes | The customer type. |
| business_name | String | 1-140 | Yes | The business name if the customer is a company. |
| String | 1-35 | Yes | The email address associated with the customer. | |
| mobile_phone_number | String | E.164 format, max 15 digits | Yes | The contact phone number for the customer. (+573402977997) |
| identification_type | String | ENUM: NIT | Yes | The type of identification |
| identification_number | String | 9 | Yes | The customer unique identification number, without check digit. |
Example Request
11
11
curl --location 'https://bre-b-sandbox.api.visionamos.passportfintech.com/v1/paas/entities/customers' \--header 'Content-Type: application/json' \--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \--data '{ "type": "BUSINESS", "business_name": "ENTITY_NAME", "email": "email@yourdomain.com", "mobile_phone_number": "MOBILE_PHONE_NUMBER", "identification_type": "NIT", "identification_number": "ENTITY_NIT_NUMBER"}'Response Body
- HTTP Status Code: 200 OK
- Returns the newly created key and its associated metadata.
Example of Response
9
9
{ "id": "cde52c0b-029e-47a7-b6fe-58996680611f", "mobile_phone_number": "MOBILE_PHONE_NUMBER", "type": "BUSINESS", "business_name": "ENTITY_NAME", "identification_type": "NIT", "email": "email@domain.com", "identification_number": "NIT_NUMBER"}Common Errors and Handling
| HTTP Status Code | Meaning | Description |
|---|---|---|
| 400 Bad Request | Invalid Data | Required fields are missing or contain incorrect values. |
| 401 Unauthorized | Expired Token | The access token is invalid or has expired. |
| 403 Forbidden | Access Denied | The request is not authorized to validate the entity. |
| 500 Internal Server Error | Server Error | An unexpected error occurred while validating the entity. |
Best Practices
- Ensure the identification type and number match the initial sign up data before validation as this is how the Sponsor Bank matches the information on their systems and will cause issues if it does not.