Updates: Check the release notes for new features and product updates.

Verify and launch an agent

After you create an agent with the Business Communications API and determine that your infrastructure is ready to hash and store messages at scale, it's time to verify and launch. Once you launch, you can use the Verified SMS API with your agent.

When you verify and launch an agent, Verified SMS confirms the agent's information with a contact from the brand that the agent represents. Once the brand contact confirms that you can represent the brand with the agent and that the agent information is correct, the agent is verified. Verified SMS immediately launches all verified agents.

Prerequisites

Before you can verify and launch your agent, you need to gather some information:

  • Agent's name, as it appears in the Business Communications API (for example, "brands/12345/agents/67890")

    If you don't know the agent's name, see List all agents for a brand.

  • Path to your GCP project's service account key on your development machine

  • Partner name (your organization's name)

  • Partner email

  • Website of the brand the agent represents, as a publicly available URL starting with "https://"

  • Contact name and email (usually shares a domain with the brand website) for the brand the agent represents who can verify your business relationship with the brand and your authority to represent the brand

Confirm your agent information

Confirm your agent information before you launch your agent. When you launch an agent, you verify that your agent's branding information is accurate. After you launch an agent, you can only update the senders field.

To get your agent's current information, see Get agent information. To update your agent's information, see Update agent information.

If you need to update read-only fields after you verify and launch your agent, contact us.

Verify an agent

When you request verification for an agent, the Business Communications API emails the brand contact you specify to confirm your agent's information.

When the brand contact verifies your agent information, Verified SMS launches your agent and sends you an email.

To verify an agent, run the following command. Replace variables with values identified in Prerequisites.

curl -X POST \
"https://businesscommunications.googleapis.com/v1/brands/BRAND_ID/agents/AGENT_ID:requestVerification" \
-H "Content-Type: application/json" \
-H "$(oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY businesscommunications)" \
-d "{
    'agentVerificationContact': {
        'partnerName': 'PARTNER_NAME',
        'partnerEmailAddress': 'PARTNER_EMAIL',
        'brandContactName': 'BRAND_CONTACT_NAME',
        'brandContactEmailAddress': 'BRAND_CONTACT_EMAIL',
        'brandWebsiteUrl': 'BRAND_WEBSITE_URL',
    },
}"

For formatting and value options, see brands.agents.requestVerification.

Get an agent's verification state

After you make an agent verification request, you can check your agent's verification state.

To get an agent's verification state, run the following command. Replace variables with values identified in Prerequisites.

curl \
"https://businesscommunications.googleapis.com/v1/brands/BRAND_ID/agents/AGENT_ID/verification" \
-H "Content-Type: application/json" \
-H "$(oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY businesscommunications)"

For formatting and value options, see brands.agents.getVerification.

Cancel an agent verification request

If you discover that agent information is incorrect or that the agent otherwise isn't ready for verification, you can cancel pending verification requests. If you cancel a request, Verified SMS notifies your brand contact, and you need to make a new verification request to restart the verification process.

To cancel an agent verification request, run the following command. Replace variables with values identified in Prerequisites.

curl -X PATCH \
"https://businesscommunications.googleapis.com/v1/brands/BRAND_ID/agents/AGENT_ID/verification" \
-H "Content-Type: application/json" \
-H "$(oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY businesscommunications)" \
-d "{
    'verificationState': 'VERIFICATION_STATE_UNVERIFIED',
}"

For formatting and value options, see brands.agents.updateVerification.

Next steps

Before you begin storing message hashes with Verified SMS,

Once you've done that, you're ready to send a verified message.