Get Clients

This endpoint allows authorized users to search for clients within the Netevia Banking platform using a search query such as an email address or phone number. It returns matching client records along with their associated financial account details. This is useful for account management, customer service lookups, and initiating transactions with specific clients.

Endpoint

GET /clients

Authentication

Bearer token required. Obtain via:

POST https://api.banking.netevia.dev/api/auth/v2

Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.

When to use

Use this endpoint when you need to locate a client record before performing account management operations, initiating a transfer, or resolving a customer service inquiry. At least one search value (email or phone number) must be supplied via the whatsLookingFor parameter. This endpoint is intended for internal partner use only and requires appropriate authorization.

Query Parameters

Response

200 OK

[
  {
    "financialAccountId": "fa-7a2c4e1d-0001",
    "doingBusinessName": "Acme Retail LLC",
    "businessPhoneNumber": "+13055550199",
    "webSite": "https://www.acmeretail.example.com",
    "accountNumberLast4": "4321",
    "fullAccountNumber": "XXXXXXXXXX"
  }
]

Error Codes

Common Mistakes

• Omitting the whatsLookingFor query parameter entirely — the API requires at least one search identifier (email or phone number) to return results.
• Sending a partial or incorrectly formatted phone number; use the full E.164 format (e.g., +13055550199) for best match results.
• Logging or displaying fullAccountNumber in plain text — always sanitize full account numbers in any UI or log output.
• Expecting a single object in the response — the endpoint returns an array of matched client records; handle zero, one, or multiple results accordingly.

Related Endpoints

• POST /api/auth/v2 — Obtain a Bearer token for authentication.
• POST /api/auth/refresh — Refresh an expiring Bearer token.
• GET /profiles/{profileId} — Retrieve full profile details for a known client by their profile ID.
• GET /financialAccounts/{financialAccountId} — Retrieve financial account details using the financialAccountId returned by this endpoint.

Example

curl -X GET "https://api.banking.netevia.dev/clients?whatsLookingFor=john.doe%40example.com" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"