api
api
Quick start
Home
Overview
Skills
Servicers
Tenants
Security model
Dev guide
Intro
User onboarding
Consuming data
Designing a tenant app
API
Sessions
Steps
Tokens
Accounts
Transactions
Payments
Powered by GitBook

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 onboarding session for a specified skill.
Request
Response
Body Parameters
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.
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
​

https://api.finqware.com/v1/sessions/:id/steps
Submits data for a certain session step.
Request
Response
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.
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"
}
Previous
The back-end
Next - API
Steps
Last updated 5 months ago