Skip to main content
An identity defines your caller’s name, phone number, voice and who they represent. Use a saved identityId or a temporary identity. Omit both to use the default for your API key’s environment. Supply only one selector; using both returns 400 invalid_request.

Use a saved identity

Create an identity in Dashboard → Settings → Identities and copy its ID. Use an identity from the same workspace and environment as your API key.

Use a temporary identity

An inline identity applies only to this search. It does not create a saved identity or inherit values from the environment default.
Alex is the caller; Jordan is the person Alex represents. The caller number is selected automatically and the catalog’s default voice is used. behalfOf.name accepts up to 100 characters; relationship accepts up to 200 and defaults to "my colleague". Text limits apply after trimming. Omit optional fields instead of sending null or empty values; unknown fields are rejected. For voice, use Copy voice key in the dashboard’s Voice selector. Display names and raw provider voice IDs are not accepted. Accepted searches retain their identity configuration and voice; edits apply to future searches. Older callAgent and callAgentId fields are rejected. Replace them with identity or a new identityId copied from Settings.