Retrieve Customer

Overview

This endpoint allows you to retrieve the details of a specific entity customer within the Passport API using the entity's unique ID. The response includes identification, business details, and contact information.

Endpoint Details

Definition	Description
Endpoint	https://bre-b-sandbox.api.visionamos.passportfintech.com/v1/paas/entities/customers/{entity_customer_id}
Method	GET
Headers	Authorization
Authentication	Access Token (Bearer Token)

Replace {entity_customer_id} with the actual unique ID of the entity customer.

Request Body

No request body

Example Request

JSON
    
    
 
curl --location 'https://bre-b-sandbox.api.visionamos.passportfintech.com/v1/paas/entities/customers/cde52c0b-029e-47a7-b6fe-58996680611f' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--data ''
Copy

Response Body

HTTP Status Code: 200 OK.
The response contains the clients data.

Example of Response

JSON
    
 
{
    "mobile_phone_number": "+5551994313232",
    "identification_type": "NIT",
    "identification_number": "6605293938",
    "email": "gmunoz+entity1@passportfintech.com",
    "id": "cde52c0b-029e-47a7-b6fe-58996680611f",
    "type": "BUSINESS",
    "business_name": "gmunozentity1"
}
Copy

Common Errors and Handling

HTTP Status Code	Meaning	Description
400 Bad Request	Invalid Request	The entity ID is missing or incorrectly formatted.
401 Unauthorized	Expired Token	The access token is invalid or has expired.
403 Forbidden	Access Denied	The request is not authorized to retrieve this entity.
404 Not Found	Entity Not Found	No entity was found with the given ID.
500 Internal Server Error	Server Error	An unexpected error occurred while retrieving the entity.

Best Practices

Ensure the entity_customer_id is correctly provided in the request URL.
Use the retrieved entity ID for subsequent API interactions.

Last updated on