Auth

Recognize a message sender by phone candidates

Trusted message-agent endpoint for recognizing phone-like sender IDs. A token is returned only when the user has approved the acting agent.

post/v1/auth/sign-in/recognize-phone

Request

  • Base URL: https://api.configure.dev
  • URL: https://api.configure.dev/v1/auth/sign-in/recognize-phone
  • Auth: API key in header X-API-Key

Headers

X-Agentstring
Example:your-agent

Required when the API key's developer account owns more than one active agent.

Request body

candidatesstring[]

Phone-like sender IDs such as E.164, tel:, sms:, imessage:, or formatted phone strings.

Response

Phone recognition result.

matchedboolean required
recognizedboolean
approvedboolean required
linkedboolean
tokenstring

Present only when approved and linked are true.

agentTokenstring

Alias for token.

userIdstring
agentstring
displayNamestring nullable
phoneCandidateCountinteger required

Example response

{
  "agent": "your-agent"
}

Changes

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