Session
Stitch a user's workflow together into a single billable Session.
What is a Session?
A Fideo-issued UUID that ties all API calls into a single billable session lasting up to 10 minutes—after which it resets—and must remain unique per workflow for compliance. This allows a user's workflow to be linked together for billing as well as for audibility.
Example
As part of an online bank sign up flow, Alice chooses to start the account creation flow.
- Signup Start - Request name and email
- Fideo receives the request which include Alice's
nameandemailand starts a new session,0197f665-6c88-7512-bc33-a7605d487377. - The risk score suggests requesting more information, such as a phone
- Fideo receives the request which include Alice's
- Phone Verification - Request additional phone
- The workflow passes along the
name,emailand nowphone. To keep it in the same session, the workflow additionally passes in thesessionIdthat was returned earlier (0197f665-6c88-7512-bc33-a7605d487377) - With the additional information of the
phone, Fideo recognizes the phone being associated with Alice' name and email, lowering the risk score around Synthetic Identity.
- The workflow passes along the
- Address Check - Request postal address
- The workflow now the
addressalong with all other previously collected elements (email,name,phone) as well as thesessionId(0197f665-6c88-7512-bc33-a7605d487377) - With all the necessary information about Alice, Fideo further reduces the risk score to a value low enough that the workflow feels comfortable passing Alice along to perform addition checks.
- The workflow now the
- Billing
- Since all three actions took place in one session, the bank is billed for only one session, despite calling Fideo 3 times. Additionally, all results form the submissions are tracked for audibility against that same
sessionId.
- Since all three actions took place in one session, the bank is billed for only one session, despite calling Fideo 3 times. Additionally, all results form the submissions are tracked for audibility against that same
- Session expiry
- If Alice stalls past 10 minutes and resubmits any data with the old
sessionId, Fideo ignores it, spins up a newsessionId, issues a fresh billable event, and resets the risk-model context—guaranteeing clear session boundaries.
- If Alice stalls past 10 minutes and resubmits any data with the old
Specifics
sessionId- ThesessionIdis used for stitching a previously submitted request together to represent a single Session for a user's experience.- The
sessionIdmust be a UUID from Fideo and cannot be a customer generated ID. - For the duration of the Session, all submitted queries count as one billable event.
- An inputted
sessionIdwill be ignored and overridden if the time since the session was generated exceeds 10 minutes, thus beginning a new billable event. - For compliance, the
sessionIdis used to look up all requests submitted during that Session.- As such, do not reuse the same
sessionIdacross workflows
- As such, do not reuse the same
- The
- Identifying Sessions
- The response code after a new Session is created is a
201. This will also be the case if Fideo replaces thesessionIdthat was provided - Subsequent requests specifying a valid
sessionIdwill receive a200response code.
- The response code after a new Session is created is a
Updated 2 months ago
