Skip to content
Authrim

Submit the active LoginUI runtime Flow step.

POST
/api/v1/login/interactions/{interaction_id}/submit
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/v1/login/interactions/example/submit \
  --header 'Content-Type: application/json' \
  --data '{ "step_id": "example", "node_id": "example", "selected_handle": "example", "contract_hash": "example", "signature": "example", "input": { "consent_item_decisions": { "additionalProperty": "granted" }, "consent_item_selected_values": { "additionalProperty": "example" }, "destination_field_decisions": { "additionalProperty": true } } }'

Advances the active runtime Flow step after verifying CSRF, interaction state, expiry, contract hash, HMAC signature, and current step identity. Step input is interpreted by the active runtime component; consent-policy input records consent item decisions and Destination Profile field selections for the authenticated user.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
interaction_id
required
string

Request Body required

Section titled “Request Body required ”
Media type application/json
object
step_id
required
string
node_id
string
selected_handle
string
contract_hash
required
string
signature
required
string
input
object
consent_item_decisions
object
key
additional properties
string
Allowed values: granted denied selected
consent_item_selected_values
object
key
additional properties
string
destination_field_decisions

Boolean decisions keyed by Destination Profile field key. Required fields must be true; optional fields set to false are omitted from release.

object
key
additional properties
boolean
key
additional properties
key
additional properties

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Updated runtime interaction state and next step.

Media type application/json
object
schema_version
required
string
interaction
required
object
key
additional properties
step
required
object | null
completed
required
boolean
output
required
object
action

Runtime completion action, such as complete or continue_protocol.

string
redirect_url

URL that LoginUI should navigate to after Flow completion.

string
protocol_continuation

Protocol-specific continuation metadata for OIDC, SAML, or direct flows.

object
key
additional properties
key
additional properties
Example generated
{
  "schema_version": "example",
  "interaction": {
    "additionalProperty": "example"
  },
  "step": "example",
  "completed": true,
  "output": {
    "action": "example",
    "redirect_url": "example",
    "protocol_continuation": {
      "additionalProperty": "example"
    }
  }
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}

404

Section titled “404 ”

Error response.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}

409

Section titled “409 ”

Error response.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}