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

Method: enabledUserKeys.batchGet

Gets public keys for specified users.

Only users enabled for Verified SMS will have a public key.

Use these keys to generate shared secrets with an agent's private key and create messages hashes.

HTTP request

POST https://verifiedsms.googleapis.com/v1/enabledUserKeys:batchGet

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation
{
  "phoneNumbers": [
    string
  ]
}
Fields
phoneNumbers[]

string

User phone numbers in E.164 format. For example, enabledUserKeys/+12223334444.

Maximum 10,000 values per API call.

Response body

If successful, the response body contains data with the following structure:

Response to request for user public keys.

JSON representation
{
  "userKeys": [
    {
      object (EnabledUserKey)
    }
  ]
}
Fields
userKeys[]

object (EnabledUserKey)

List of enabled user public keys. Users not enabled will not have a public key.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/verifiedsms

For more information, see the OAuth 2.0 Overview.

EnabledUserKey

A public key of an enabled user.

This object includes a public key of Verified SMS user who is enabled on the platform. Users not enabled for Verified SMS will not have a public key.

JSON representation
{
  "phoneNumber": string,
  "publicKey": string
}
Fields
phoneNumber

string

A user's phone number in E.164 format. For example, +12223334444.

publicKey

string (bytes format)

A public key value, with a size of 120 bytes, created with elliptic curve NIST P-384.

A base64-encoded string.