post https://api-prod.everee.com/api/v2/embedded/session
Creates a Component session that can be started by opening the returned URL in a web view.
Available Component types
These are the Component types currently available. Note the "Version" required for each—these change periodically as new major versions of these experiences are rolled out.
| Component name | Version | Description |
|---|---|---|
ONBOARDING | V2_0 | Worker-facing onboarding experience. |
PAYMENT_HISTORY | V1_0 | Worker-facing payment history, including access to earning totals and PDF pay statements. |
TAX_DOCUMENTS | V1_0 | Worker-facing year end tax document access, including Form 1099 and Form W-2 (depending on worker classification). |
PAYMENT_DEPOSIT | V1_0 | Worker-facing deposit management experience, including bank account information capture. |
HOME_ADDRESS | V1_0 | Worker-facing home address management experience. |
WORKER_HOME | V1_0 | Worker-facing "hub" experience, including navigation links to the other embedded component experiences. |
INSTANT_PAY | V1_0 | Worker-facing Instant Pay request experience, includes debit card capture. Provides empty state if no approved funds are available for the worker. |
Sessions expire quickly
Component sessions have a limited lifetime for security purposes. You should only create a Component session immediately before you use it, not in advance. The session URL expires quickly, so this should be called immediately before presenting the Component in the UX.