auth.signin.start
curl --request POST \
--url https://platform.trylath.com/auth/signin/start \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"identifier": "<string>",
"redirectTo": "<string>",
"locale": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({identifier: '<string>', redirectTo: '<string>', locale: '<string>'})
};
fetch('https://platform.trylath.com/auth/signin/start', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://platform.trylath.com/auth/signin/start"
payload = {
"identifier": "<string>",
"redirectTo": "<string>",
"locale": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.trylath.com/auth/signin/start"
payload := strings.NewReader("{\n \"identifier\": \"<string>\",\n \"redirectTo\": \"<string>\",\n \"locale\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"activityId": "<string>",
"result": {
"challengeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"method": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"delivery": "queued",
"messageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}auth.signin.start
Begins a sign-in for an end user: creates a one-time code or link, queues the message from the project’s default sender, and returns the challenge id. Never reveals whether the user already exists.
POST
/
auth
/
signin
/
start
auth.signin.start
curl --request POST \
--url https://platform.trylath.com/auth/signin/start \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"identifier": "<string>",
"redirectTo": "<string>",
"locale": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({identifier: '<string>', redirectTo: '<string>', locale: '<string>'})
};
fetch('https://platform.trylath.com/auth/signin/start', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://platform.trylath.com/auth/signin/start"
payload = {
"identifier": "<string>",
"redirectTo": "<string>",
"locale": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.trylath.com/auth/signin/start"
payload := strings.NewReader("{\n \"identifier\": \"<string>\",\n \"redirectTo\": \"<string>\",\n \"locale\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"activityId": "<string>",
"result": {
"challengeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"method": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"delivery": "queued",
"messageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Authorizations
A Lath API key: lath_live_sk… or lath_test_sk… on a server, lath_live_pk… or lath_test_pk… in a browser.
Headers
Replays the stored response for the same key and input; refuses different input.
Body
application/json
Available options:
email_code, email_link, sms_code The email address, or the E.164 phone number for sms_code
Required string length:
3 - 320For email_link: where the hosted landing page sends the user afterwards
Send the sign-in message in this language, if a variant of the template exists for it. Omit to use the user's recorded language, which a first-time visitor does not yet have.
Maximum string length:
20Last modified on September 13, 2026
Was this page helpful?

