EVeveree

Create embedded experience URL

Creates a magic link for an embedded experience that can be started by opening the returned URL in a webview.

post/integration/v1/embedded/session

Request

  • Base URL
    https://api.everee.com
  • URL
    https://api.everee.com/integration/v1/embedded/session
  • Auth
    API key in header Authorization

Request body

workerIdstring

Required for worker components if "externalWorkerId" is null

externalWorkerIdstring

Required for worker components if "workerId" is null

eventHandlerNamestring required

see "Handling events" in the Embed Implementation guide

experience'ONBOARDING' | 'PAYMENT_HISTORY' | 'TAX_DOCUMENTS' | 'HOME_ADDRESS' | 'PAYMENT_DEPOSIT' | 'WORKER_HOME' | 'PAY_CARD_SIGNUP' | 'COMPANY_CONTRACT' | 'FUNDING_BANK_ACCOUNT' required

The component to display. For Payroll Infrastructure, the relevant components are "COMPANY_CONTRACT" (during company onboarding) and "FUNDING_BANK_ACCOUNT" (after onboarding, coming soon). The company-level components don't take a worker, so omit "workerId" and "externalWorkerId" for them.

experienceVersionstring

Optional. The version of the component to display. When omitted, the current version is used.

Response

201

Changes

No recorded changes to this operation across all 1 revision of this API.