Exchange a prefill token for its email address
curl --request GET \
--url https://web-api.dev.soxai.site/api/deep-link/prefill-emailimport requests
url = "https://web-api.dev.soxai.site/api/deep-link/prefill-email"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://web-api.dev.soxai.site/api/deep-link/prefill-email', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"email": "member@example.com"
}{
"error": "invalid_or_expired_token",
"error_msg": "invalid or expired token"
}{
"error": "unprocessable-entity",
"error_msg": "body.<field>: <validation message>"
}{
"error": "rate-limited",
"error_msg": "Rate limit exceeded. Retry after <n> seconds."
}{
"error": "internal-server-error",
"error_msg": "Failed to fetch data: <error_message>"
}Deep Links
Exchange a prefill token for its email address
Not part of the Sandbox
A Sandbox key does not authenticate this endpoint and a Sandbox identity cannot complete it, because it would send or resolve a real email. It is published here because the Sandbox runs the same build. See Sandbox.
Return the email address carried by a login-prefill token, so the app can prefill its sign-up or login form from a deep link.
Parameters
token(query, required) - the prefill token from the deep link’s query string.
Response
200{"email": "..."}.
Errors
| Status | Condition |
|---|---|
| 400 | The token is empty, unknown, or expired. All three answer {"error": "invalid_or_expired_token"}, so a caller cannot tell a malformed token from an expired one |
Authorization
- No authentication. The recipient of the link has not signed in yet - prefilling the form is what precedes it - so the token is the credential.
GET
/
api
/
deep-link
/
prefill-email
Exchange a prefill token for its email address
curl --request GET \
--url https://web-api.dev.soxai.site/api/deep-link/prefill-emailimport requests
url = "https://web-api.dev.soxai.site/api/deep-link/prefill-email"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://web-api.dev.soxai.site/api/deep-link/prefill-email', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"email": "member@example.com"
}{
"error": "invalid_or_expired_token",
"error_msg": "invalid or expired token"
}{
"error": "unprocessable-entity",
"error_msg": "body.<field>: <validation message>"
}{
"error": "rate-limited",
"error_msg": "Rate limit exceeded. Retry after <n> seconds."
}{
"error": "internal-server-error",
"error_msg": "Failed to fetch data: <error_message>"
}