WHwhispa
integrations
crm

Lookup Crm Account Sessionless

Read-only account lookup that needs no call session.

Backs pre-call tools (the payment calculator's loan-id lookup) so an agent can pull account context before dialing. It never mutates state.

Because this path is not tied to a call the agent owns, it is deliberately restricted to exact record identifiers (account number / customer id). Broad demographic criteria (phone, email, name, DOB) and the creditor-wide client_id are rejected here: they turn a targeted pre-call lookup into a tool for sweeping the customer book by matching partial PII. Those criteria remain available on the session-scoped /sessions/{id}/crm/lookup route, which is gated to a call the agent is actually handling. Every call is audit-logged with the caller so bulk enumeration is attributable.

post/integrations/crm/lookup

Request

  • Base URL
    https://dev.whispa.net (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Password
      Token URL: auth/bearer/login
    • or API key in cookie access_token

Request body

phonestring nullable

Phone number to match

emailstring nullable

Email address to match

namestring nullable

Customer name to match

dobstring date nullable

Date of birth to match

account_numberstring nullable

Provider-side account number to match

customer_idstring nullable

Provider-side customer id to match

client_idstring nullable

Owning creditor / client id to match

Response

Successful Response

total_matchedinteger
truncatedboolean

Changes

No recorded changes to this operation across all 1 revision of this API.