Flows

Start Flow

API schema

This method starts a flow for an action. The action must be a Flows action with a published flow. Identify the user with exactly one of userId, email, phoneNumber or username. Send the user to the returned challengeUrl to complete each step in the pre-built UI. When they finish, the pre-built UI redirects back to your redirectUrl with a challenge_token.

const response = await authsignal.startFlow({
  actionCode: "signIn",
  user: {
    userId: "69904f34-8286-4f35-9484-006a5a22ea1a",
  },
  redirectUrl: "https://yourapp.com/callback",
  clientId: "46194bdd-d865-490c-ac0a-c59c73e628cd",
});

const { challengeUrl, challengeToken } = response;

var request = new StartFlowRequest(
    ActionCode: "signIn",
    User: new UserLookup(UserId: "69904f34-8286-4f35-9484-006a5a22ea1a"),
    RedirectUrl: "https://yourapp.com/callback",
    ClientId: "46194bdd-d865-490c-ac0a-c59c73e628cd"
);

var response = await authsignal.StartFlow(request);

var challengeUrl = response.ChallengeUrl;
var challengeToken = response.ChallengeToken;

StartFlowRequest request = new StartFlowRequest();
request.actionCode = "signIn";
request.user = new UserLookup();
request.user.userId = "69904f34-8286-4f35-9484-006a5a22ea1a";
request.redirectUrl = "https://yourapp.com/callback";
request.clientId = "46194bdd-d865-490c-ac0a-c59c73e628cd";

StartFlowResponse response = authsignal.startFlow(request).get();

String challengeUrl = response.challengeUrl;
String challengeToken = response.challengeToken;

response = Authsignal.start_flow(
  action_code: "signIn",
  user: {
    user_id: "69904f34-8286-4f35-9484-006a5a22ea1a"
  },
  redirect_url: "https://yourapp.com/callback",
  client_id: "46194bdd-d865-490c-ac0a-c59c73e628cd"
)

challenge_url = response[:challenge_url]
challenge_token = response[:challenge_token]

response = authsignal.start_flow(
    action_code="signIn",
    user={
        "userId": "69904f34-8286-4f35-9484-006a5a22ea1a"
    },
    redirect_url="https://yourapp.com/callback",
    client_id="46194bdd-d865-490c-ac0a-c59c73e628cd"
)

challenge_url = response["challenge_url"]
challenge_token = response["challenge_token"]

$response = Authsignal::startFlow([
    'actionCode' => 'signIn',
    'user' => [
        'userId' => '69904f34-8286-4f35-9484-006a5a22ea1a'
    ],
    'redirectUrl' => 'https://yourapp.com/callback',
    'clientId' => '46194bdd-d865-490c-ac0a-c59c73e628cd'
]);

$challengeUrl = $response['challengeUrl'];
$challengeToken = $response['challengeToken'];

userId := "69904f34-8286-4f35-9484-006a5a22ea1a"
redirectUrl := "https://yourapp.com/callback"
clientId := "46194bdd-d865-490c-ac0a-c59c73e628cd"

response, err := client.StartFlow(
    StartFlowRequest{
        ActionCode:  "signIn",
        User:        &UserLookup{UserId: &userId},
        RedirectUrl: &redirectUrl,
        ClientId:    &clientId,
    },
)

challengeUrl := response.ChallengeUrl
challengeToken := response.ChallengeToken

Verify Flow

API schema

This method returns the result of a flow. The action state is CHALLENGE_SUCCEEDED once the user has completed every required step, or CHALLENGE_FAILED if the flow ended in a Block outcome or the user couldn’t complete a step. To get session tokens, enable the JWKS URL for your tenant and pass an app client’s ID as clientId to Start Flow. Verify Flow then returns access and refresh tokens when the action state is CHALLENGE_SUCCEEDED and the user completed at least one verification step. A flow that only enrolls a method doesn’t return tokens. See Session management.

const response = await authsignal.verifyFlow({
  actionCode: "signIn",
  challengeToken,
});

if (response.action.state === "CHALLENGE_SUCCEEDED") {
  const accessToken = response.session?.accessToken;
}

var request = new VerifyFlowRequest(
    ActionCode: "signIn",
    ChallengeToken: challengeToken
);

var response = await authsignal.VerifyFlow(request);

if (response.Action.State == FlowState.CHALLENGE_SUCCEEDED)
{
    var accessToken = response.Session?.AccessToken;
}

VerifyFlowRequest request = new VerifyFlowRequest();
request.actionCode = "signIn";
request.challengeToken = challengeToken;

VerifyFlowResponse response = authsignal.verifyFlow(request).get();

if (response.action.state == FlowState.CHALLENGE_SUCCEEDED) {
    if (response.session != null) {
        String accessToken = response.session.accessToken;
    }
}

response = Authsignal.verify_flow(
  action_code: "signIn",
  challenge_token: challenge_token
)

if response[:action][:state] == "CHALLENGE_SUCCEEDED"
  access_token = response.dig(:session, :access_token)
end

response = authsignal.verify_flow(
    action_code="signIn",
    challenge_token=challenge_token
)

if response["action"]["state"] == "CHALLENGE_SUCCEEDED":
    access_token = response.get("session", {}).get("access_token")

$response = Authsignal::verifyFlow([
    'actionCode' => 'signIn',
    'challengeToken' => $challengeToken
]);

if ($response['action']['state'] === 'CHALLENGE_SUCCEEDED') {
    $accessToken = $response['session']['accessToken'] ?? null;
}

response, err := client.VerifyFlow(
    VerifyFlowRequest{
        ActionCode:     "signIn",
        ChallengeToken: challengeToken,
    },
)

if response.Action.State == FlowStateChallengeSucceeded {
    if response.Session != nil {
        accessToken := response.Session.AccessToken
    }
}

Server

Client

Call Connect

Start Flow

API schema

Verify Flow

API schema

​Start Flow

API schema

​Verify Flow

API schema

Start Flow

Verify Flow