Sessions

An ordered sequence of steps that can be used to build conversational UIs (eg: product onboarding).

post
Create session

https://api.finqware.com/v1/sessions
Initializes an on-boarding session for a specified skill. The tenant_user_id may be any string that uniquely identifies an end-user using your tenant app (eg: uuid, opaque string, etc).
Request
Response
Request
Body Parameters
tenant_user_id
required
string
An identifier of your end-user.
client_id
required
string
An identifier for your tenant app.
client_app_key
required
string
Authorization key.
skill
required
string
The skill you're implementing.
Response
200: OK
Session successfully started. The nonce is a temporary key that should be used when submitting data for the next step in this session.
{
"nonce": "MDAxNmxvY2F0a...z0sBtsOyVdJ04kK",
"session_id": "58f92378-...-20a052aca460",
"status": "SESSION_CREATED"
}
400: Bad Request
{
"message": "Error message"
}

post
Submit step for session

https://api.finqware.com/v1/sessions/:id/steps
Submits data for a certain session step.
Request
Response
Request
Path Parameters
id
required
string
The session id
Body Parameters
client_id
required
string
An identifier for your tenant app.
nonce
required
string
A temp key received from a previous step.
skill
required
string
The skill you're implementing.
step
required
string
The name of the step you're submitting data for.
data
required
object
The payload for this specific step.
Response
200: OK
Use the step_id to submit additional data specific to this step (eg: file uploads). Use the newly generated nonce to submit data for the next step within the current session. The data payload depends on the step you're implementing.
{
"step_id": "58f92378-...-20a052aca460",
"nonce": "MDAxNmxvY2F0a...z0sBtsOyVdJ04kK",
"status": "SESSION_IN_PROGRESS",
"data": {}
}
400: Bad Request
{
"message": "Error message"
}