Endpoint Structure
Introduction
Understanding the structure of Passport API endpoints is essential for seamless integration. This guide provides a clear breakdown of the base URL, API versioning, and best practices for constructing API requests.
Base URL
All API requests to the Passport platform must be sent to the following base URL:
https://bre-b-sandbox.api.visionamos.passportfintech.comAlways ensure that you are using HTTPS to secure data transmission.
API Versioning
Passport API follows a versioning system to ensure backward compatibility. The version is included as part of the endpoint path:
https://bre-b-sandbox.api.visionamos.passportfintech.com/version/Current Stable Version
https://bre-b-sandbox.api.visionamos.passportfintech.com/v1/Tip: When integrating, always check the latest API version in this documentation to take advantage of updates and improvements.
Endpoint Structure
Each API endpoint follows a structured format:
base_url/version/resource/identifierExample Breakdown
| Segment | Description |
|---|---|
| {base_url} | The root domain where API requests are sent. |
| {version} | The API version (e.g., v1). |
| {resource} | The primary resource being accessed (e.g., iam/oauth/tokens). |
| {identifier} | A unique ID if needed (e.g., in a GET method iam/oauth/tokens/{token_id}). |
Request and Response Structure
Request Format
All requests to the API should be structured using JSON and include necessary authentication headers.
Example of Request
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": "d490794d-183f-4226-80a7-e75edce0e4fe", "type": "ORDINARY"}'Response Format
API responses are structured in JSON and provide clear and detailed overview of the object.
Example of Response
{ "available_balance": { "currency": "COP", "value": "0" }, "pending_balance": { "currency": "COP", "value": "0" }, "type": "ORDINARY", "entity_customer_id": "d490794d-183f-4226-80a7-e75edce0e4fe", "number": "880368444", "id": "ca3fe9c0-7ddd-455d-92c1-4c749d22c0ee"}