Search Business Profile

This endpoint searches registered business profiles on the Netevia platform by name. It returns a list of matching businesses with their profile IDs and phone numbers, making it useful for locating a recipient before initiating a transfer or linking accounts.

Endpoint

GET /clientName

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 look up a business customer's profile ID before performing a business-to-business internal transfer or assigning an authorized user to another account. It is also useful when building search or autocomplete UI components that help users find and select recipient businesses by name.

Query Parameters

Response

200 OK

Returns an array of matching business profiles.

[
  {
    "profileId": 100234,
    "doingBusinessName": "Acme Supplies LLC",
    "businessPhoneNumber": "+1-555-867-5309"
  },
  {
    "profileId": 100411,
    "doingBusinessName": "Acme Logistics Inc",
    "businessPhoneNumber": "+1-555-222-4400"
  }
]

Error Codes

Common Mistakes

• Omitting the q parameter entirely may return a large default set (up to 10 records); always provide a search term for meaningful results.
• Setting take to a very high value may cause performance degradation; keep pagination in mind and use reasonable limits.
• Using this endpoint to search personal customer profiles will yield no results — it is scoped to business profiles only.
• The profileId returned here is needed for downstream calls such as business-to-business transfers; save it rather than calling this endpoint repeatedly.

Related Endpoints

• POST /api/auth/v2 — Obtain a Bearer token for authentication
• POST /api/transfer/internal — Initiate an internal transfer to another Netevia business user using the retrieved profileId
• GET /api/profile/{profileId} — Retrieve full profile details for a specific business using their profileId

Example

curl -X GET "https://api.banking.netevia.dev/clientName?q=Acme&take=5" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"