Obter os próximos passos antes de entrar
RegistosGET /next-steps
Returns the resident entry before sign-in: exactly two doors (link an existing account, request a new connection) and the public utility lookup and request-status actions, each with localized text and a help article ID, plus a signed timing token that holds no user, contact, account, tenant, IP or device identifier. Nothing here is a checklist step; a journey starts only when the resident picks a door.
Parâmetros
audienceOnly resident is supported
um de
resident
Devolve
200 Resident entry
Mostrar atributos
audienceum de
platform,business,consumer,residentlocaleum de
pt-MZ,en-USgenerated_atstepsMostrar atributos filhos
idjourney_idtitlelinestateum de
todo,blockedownerum de
you,platform_review,team_member,utility_owneractionMostrar atributos filhos
idPortable destination intent each client maps to its own screen
labelLocalized action label
routeIn-app route on the platform dashboard (platform setup only)
helpMostrar atributos filhos
article_idHelp registry category/slug
blocked_reasonMostrar atributos filhos
codemessage
wait_lineOptional, localized like line. On the utility's review step (documents) until approval: how long the platform's review usually takes. Present only when the server has a figure: the median of past decided reviews once there are at least 3, else the configured onboarding.review_wait (default 0, meaning absent).
doorsThe two resident entry doors (public entry only)
Mostrar atributos filhos
idtitlelinehelpMostrar atributos filhos
article_id
actionsPublic utility lookup and request-status actions (public entry only)
Mostrar atributos filhos
idtitlelinehelpMostrar atributos filhos
article_id
run_tokenOpaque run token for a staff journey or the anonymous resident entry
Erros 400
curl -X GET "$PUBLIC_API/next-steps"
# Sem comando CLI equivalente; use cURL ou HTTP directo.
const res = await fetch("$PUBLIC_API/next-steps", {
method: "GET"
});
const data = await res.json();
import requests
res = requests.get(
"$PUBLIC_API/next-steps"
)
data = res.json()
req, _ := http.NewRequest("GET", "$PUBLIC_API/next-steps", nil)
resp, err := http.DefaultClient.Do(req)
{
"audience": "platform",
"locale": "pt-MZ",
"generated_at": "2026-11-19T09:30:00Z",
"steps": [
{
"id": "customer_import",
"journey_id": "utility_real",
"title": "Fuga na Rua 3",
"line": "line",
"state": "todo",
"owner": "you",
"action": {
"id": "utility.real.customer_import",
"label": "label",
"route": "/platform/settings/branding"
},
"help": {
"article_id": "getting-started/import-customers"
},
"blocked_reason": {
"code": "review_pending",
"message": "Leitura confirmada no local."
},
"wait_line": "A revisão costuma demorar cerca de 2 dias."
}
],
"doors": [
{
"id": "resident.link-existing-account",
"title": "Fuga na Rua 3",
"line": "line",
"help": {
"article_id": "residents/link-resident-account"
}
}
],
"actions": [
{
"id": "resident.link-existing-account",
"title": "Fuga na Rua 3",
"line": "line",
"help": {
"article_id": "residents/link-resident-account"
}
}
],
"run_token": "run token"
}