Skip to main content
POST
/
v1
/
b2b
/
otps
/
email
/
discovery
/
send
C#
// POST /v1/b2b/otps/email/discovery/send
const stytch = require('stytch');

const client = new stytch.B2BClient({
  project_id: '${projectId}',
  secret: '${secret}',
});

const params = {
  email_address: "sandbox@stytch.com",
};

client.OTPs.Email.Discovery.Send(params)
  .then(resp => { console.log(resp) })
  .catch(err => { console.log(err) });
// POST /v1/b2b/otps/email/discovery/send
package main

import (
"context"
"log"

"github.com/stytchauth/stytch-go/v18/stytch/b2b/b2bstytchapi"
"github.com/stytchauth/stytch-go/v18/stytch/b2b/otp/email/discovery"
)

func main() {
client, err := b2bstytchapi.NewClient(
"${projectId}",
"${secret}",
)
if err != nil {
log.Fatalf("error instantiating client: %v", err)
}

params := &discovery.SendParams{
EmailAddress: "sandbox@stytch.com",
}

resp, err := client.OTPs.Email.Discovery.Send(context.Background(), params)
if err != nil {
log.Fatalf("error in method call: %v", err)
}

log.Println(resp)
}
// POST /v1/b2b/otps/email/discovery/send
package com.example;

import com.stytch.java.b2b.models.otpemaildiscovery.SendRequest;
import com.stytch.java.b2b.StytchB2BClient;
import com.stytch.java.common.StytchResult;

public class Main {
public static void main(String[] args) {
StytchB2BClient.configure("${projectId}", "${secret}");

SendRequest params = new SendRequest();
params.setEmailAddress("sandbox@stytch.com");

Object result = StytchB2BClient.getOTPs().getEmail().getDiscovery().send(params);
if (result instanceof StytchResult.Success) {
System.out.println(((StytchResult.Success) result).getValue());
} else {
System.out.println(((StytchResult.Error) result).getException());
}
}
}
// POST /v1/b2b/otps/email/discovery/send
package com.example

import com.stytch.java.b2b.StytchB2BClient
import com.stytch.java.b2b.models.otpemaildiscovery.SendRequest

fun main() {
StytchB2BClient.configure(
projectId = "${projectId}",
secret = "${secret}",
)

when (
val result =
StytchB2BClient.otps.email.discovery.send(
SendRequest(
emailAddress = "sandbox@stytch.com",
),
)
) {
is StytchResult.Success -> println(result.value)
is StytchResult.Error -> println(result.exception)
}
}
// POST /v1/b2b/otps/email/discovery/send
const stytch = require('stytch');

const client = new stytch.B2BClient({
project_id: '${projectId}',
secret: '${secret}',
});

const params = {
email_address: "sandbox@stytch.com",
};

client.otps.email.discovery.send(params)
.then(resp => { console.log(resp) })
.catch(err => { console.log(err) });
$response = $client->otps->email->discovery->send([
'email_address' => 'sandbox@stytch.com',
]);
# POST /v1/b2b/otps/email/discovery/send
from stytch import B2BClient

client = B2BClient(
project_id="${projectId}",
secret="${secret}",
)

resp = client.otps.email.discovery.send(
email_address="sandbox@stytch.com",
)

print(resp)
# frozen_string_literal: true

# POST /v1/b2b/otps/email/discovery/send
require 'stytch'

client = StytchB2B::Client.new(
project_id: "${projectId}",
secret: "${secret}"
)

resp = client.otps.email.discovery.send(
email_address: "sandbox@stytch.com"

)

puts resp
// POST /v1/b2b/otps/email/discovery/send
use stytch::b2b::client::Client;
use stytch::b2b::otp_email_discovery::SendRequest;

fn main() {
let client = Client::new("${projectId}", "${secret}").unwrap();
let resp = client.otps.email.discovery.send(
SendRequest{
email_address: "sandbox@stytch.com",
..Default::default()
}
).await;
println!("The response is {:?}", resp);
}
# POST /v1/b2b/otps/email/discovery/send
curl --request POST \
--url https://test.stytch.com/v1/b2b/otps/email/discovery/send \
-u '${projectId}:${secret}' \
-H 'Content-Type: application/json' \
-d '{
"email_address": "sandbox@stytch.com"
}'
{
  "request_id": "<string>",
  "status_code": 123
}
{
"status_code": 401,
"request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
"error_type": "unauthorized_credentials",
"error_message": "Unauthorized credentials.",
"error_url": "https://stytch.com/docs/api/errors/401"
}
{
"status_code": 429,
"request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
"error_type": "too_many_requests",
"error_message": "Too many requests have been made.",
"error_url": "https://stytch.com/docs/api/errors/429"
}
{
"status_code": 500,
"request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
"error_type": "internal_server_error",
"error_message": "Oops, something seems to have gone wrong, please reach out to support@stytch.com to let us know what went wrong.",
"error_url": "https://stytch.com/docs/api/errors/500"
}
Send a discovery OTP to an email address. The OTP is valid for 10 minutes. Only the most recently sent OTP is valid: when an OTP is sent, all OTPs previously sent to the same email address are invalidated, even if unused or unexpired.

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

Request type

email_address
string
required

The email address to start the discovery flow for.

login_template_id
string

Use a custom template for login emails. By default, it will use your default email template. Templates can be added in the Stytch dashboard using our built-in customization options or custom HTML templates with type “OTP - Login”.

locale
enum<string>

Used to determine which language to use when sending the user this delivery method. Parameter is an IETF BCP 47 language tag, e.g. "en".

If no value is provided, the copy defaults to English.

Available options:
en,
es,
pt-br,
fr
discovery_expiration_minutes
integer<int32>

The expiration time, in minutes, for a discovery OTP email. If not accepted within this time frame, the OTP will need to be resent. Defaults to 10 with a minimum of 2 and a maximum of 15.

Required range: x >= 0

Response

Successful response

request_id
string
required

Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.

status_code
integer<int32>
required

The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.