Send Verification Code (SMS/EMAIL)

POST 
/auth/v1/verification

Send Verification Code (SMS/EMAIL)

Request

application/json

Body

required

email string
phone_number string
target - ANY: Any target - USER: Phone number must exist in the system - NOT_USER: Phone number must not exist in the system - CUR_USER: Current user. When selecting current user, phone/email can be masked values, authentication passed in header (string)

Possible values: [ANY, USER, NOT_USER, CUR_USER]

Default value: ANY

locale string
usage string
destination string

Responses

200

A successful response.

application/json

Schema

Schema

verification_id string
is_user Determines whether this phone number has been registered as a user (boolean)
expires_in int32
limit object
duration int32
limit int32
remaining int32
reset int32

Example (from schema)

{
  "verification_id": "string",
  "is_user": true,
  "expires_in": 0,
  "limit": {
    "duration": 0,
    "limit": 0,
    "remaining": 0,
    "reset": 0
  }
}

401

the oauth2.0 access token is not correct or expired

application/json

Schema

Schema

any

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...