Clients

API Method: POST /api/Search/v2/clients

Description:

This endpoint is used to search for clients by email address or phone number within the banking application. It returns detailed information about the client, including personal details and associated financial accounts. This method is useful for identifying clients during transactions, customer support inquiries, or internal account management.

Request:

• HTTP Method: POST
• Endpoint: /api/Search/v2/clients
• Authentication: Requires authentication (e.g., Bearer token or session ID) to ensure that only authorized users can search for and access client information.

Request Body:

• Content-Type: application/json

Example Request Body:

{
    "whatsLookingFor": "[email protected]"               // The email address or phone number being searched for
}

Or:

{
    "whatsLookingFor": "1234567890"               // The email or phone number being searched for
}

Request Fields:

• whatsLookingFor (string, required): Indicates the type of search criteria, either email or phone. The value should be one of these two options.
• value (string, required): The email address or phone number of the client being searched.

Response:

• Status Code: 200 OK — On success, the API returns information about the client, including personal details and financial account data.
• Content-Type: application/json

Possible Errors:

• 400 Bad Request: The request is missing required parameters or the search type (email or phone) is invalid.
• 401 Unauthorized: The request was made without proper authentication or with an invalid token.
• 403 Forbidden: The user does not have permission to search for clients.
• 404 Not Found: No client found with the provided email or phone number.
• 500 Internal Server Error: An error occurred on the server while processing the request.

This request searches for a client by either their email address or phone number, and returns the client's personal information and financial account details, such as account balances and account types.