Search Clients

This endpoint searches for a client within the Netevia Banking platform using either an email address or a phone number. On a successful match, it returns the client's business profile information along with their associated financial account identifiers. It is intended for partner-side operations such as transaction lookup, customer support, and internal account management.

Endpoint

POST /api/Search/v2/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 initiating a transaction, resolving a support inquiry, or linking an operation to a specific account. It is appropriate any time the partner knows only a client's contact information and needs to retrieve the corresponding Netevia account details. This endpoint is useful for both business and personal customer lookups.

Request Body

{
  "whatsLookingFor": "[email protected]"
}

Or using a phone number:

{
  "whatsLookingFor": "1234567890"
}

Response

200 OK

{
  "financialAccountId": "fa_9b3c1e2d4f5a6078",
  "doingBusinessName": "Acme Retail LLC",
  "businessPhoneNumber": "555-123-4567",
  "webSite": "https://acmeretail.example.com",
  "accountNumberLast4": "8901",
  "fullAccountNumber": "XXXXXXXXXX"
}

Error Codes

Common Mistakes

• Passing a formatted phone number with dashes or parentheses (e.g., (123) 456-7890) instead of digits only — use 1234567890.
• Omitting the whatsLookingFor field entirely, which will return a 400 error.
• Logging or displaying fullAccountNumber in plain text — always mask it as XXXXXXXXXX in interfaces and logs.
• Using an expired Bearer token — tokens expire after 10 minutes; refresh via POST /api/auth/refresh before retrying.

Related Endpoints

• POST /api/auth/v2 — Obtain a Bearer token for authentication
• POST /api/auth/refresh — Refresh an existing Bearer token
• GET /api/v2/clients/{clientId} — Retrieve full client profile by ID
• GET /api/v2/financialAccounts/{financialAccountId} — Retrieve financial account details by ID

Example

curl -X POST https://api.banking.netevia.dev/api/Search/v2/clients \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "whatsLookingFor": "[email protected]"
  }'