Registration
Initialize or advance a registration flow.
Headers
Used to internationalize outgoing emails (e.g. for email verification, recovery, etc.).
If email delivery by Hanko is enabled the values for supported languages are:
- "bn" (Bengali/Bangla)
- "de" (German)
- "en" (English)
- "fr" (French)
- "it" (Italian)
- "pt-BR" (Brazilian Portuguese),
- "zh" (Chinese)
If email delivery by Hanko is disabled and a webhook has been configured for the email.send
event, the
JWT payload of the token
contained in the response to the webhook endpoint contains a language
claim that
reflects the value originally passed as the header value.
Query Parameters
String of the format {action_name}@{flow_id}
. Indicates the action to perform on the flow with the
given flow_id
. Omitting the query parameter initializes a new flow.
Note for playground usage: You can derive the value for this query parameter from the action
's href
property in a flow state response, e.g. for an href
value of
/login?action=register_client_capabilities%4015655672-41ca-48cc-afb1-90be77075764
the (non-URL-encoded) value
would be register_client_capabilities@15655672-41ca-48cc-afb1-90be77075764
.
"register_client_capabilities@15655672-41ca-48cc-afb1-90be77075764"
Body
The body is of type object
.
Response
The response is of type object
.
The response is of type object
.
Represents the initial state of a registration flow.
The response is of type object
.
The response is of type object
.
The response is of type object
.
The response is of type object
.
The response is of type object
.
The response is of type object
.
The response is of type object
.
The response is of type object
.
The response is of type object
.
The response is of type object
.