create_authorization
Create an authorization request that grants permission to send confirmations to a user through a specified channel; the user must approve it before confirmations are sent.
Instructions
Create a new authorization request. Authorizations grant permission to send confirmations to a user via a specific channel. The user must approve the authorization before confirmations can be sent.
ACCESS: needs a Proof account. Set PROOF_API_KEY and restart this server, then call this tool again. start_login does NOT open this tool.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bsuid | No | WhatsApp Business-Scoped User ID (alternative to phone for WhatsApp channel) | |
| phone | Yes | Target phone number in E.164 format (e.g., +15551234567) | |
| scope | No | Authorization scope (default: confirmations) | |
| channel | Yes | Channel for sending confirmations | |
| hitl_id | Yes | HITL configuration ID to link this authorization to | |
| recipient | Yes | Channel-specific recipient identifier (chat_id for Telegram, phone/BSUID for WhatsApp) | |
| expires_in | No | Expiry in seconds (max 90 days, default 90 days) | |
| business_name | No | Deprecated and ignored: the consent message always names the approval setup's sub-account. Leave it out. | |
| business_profile_id | No | Sub-account to record on the authorization (does not change the name the person sees) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | MongoDB ObjectId | |
| bsuid | No | WhatsApp Business-Scoped User ID | |
| phone | No | ||
| scope | Yes | Scope of the authorization. `identity_challenge` is the Proof of Me scope. | |
| status | Yes | Status of an authorization | |
| channel | Yes | Channel authorized for sending confirmations | |
| hitl_id | Yes | ||
| recipient | No | Channel-specific recipient identifier (chat_id for Telegram, phone or BSUID for WhatsApp) | |
| created_at | Yes | ||
| expires_at | Yes | ||
| business_name | Yes | The name the consent message carried: the approval setup's sub-account name, never a name typed in the request. | |
| authorization_url | Yes | URL to send to the user for authorization |