Jump to Content
Documentation
Reference
Log In
Reference
Log In
Documentation
Reference
Retrieve all SSO Connections
All
Pages
Start typing to search…
JUMP TO
Overview
Reference Overview
REST API
Authentication
Create User API token
post
Documents
Retrieve Document
get
Generate document link
post
Employers
Retrieve Employers
get
Create Employer
post
Delete Employer
del
Retrieve Employer
get
Update Employer
put
Retrieve EmployerContactMethods
get
Retrieve an EmployerContactMethod
get
Retrieve all worker terminations of an employer
get
Accept or reject Employer Terms of Service
post
Employer Account Standing
Retrieve employer account standing
get
Employer Capabilities
Retrieve employer capabilities
get
Benefit
Retrieve all EmployerBenefitTypes
get
Create EmployerBenefitType
post
Delete EmployerBenefitType
del
Retrieve a single EmployerBenefitType
get
Update EmployerBenefitType
patch
Retrieve all PartnerBenefitTypes
get
Retrieve a single PartnerBenefitType
get
Pay
Retrieve all EmployerPayTypes
get
Create EmployerPayType
post
Delete EmployerPayType
del
Retrieve a single EmployerPayType
get
Update EmployerPayType
patch
Retrieve all PartnerPayTypes
get
Retrieve a single PartnerPayType
get
Time Off
Retrieve all EmployerTimeOffTypes
get
Create EmployerTimeOffType
post
Delete EmployerTimeOffType
del
Retrieve a single EmployerTimeOffType
get
Update EmployerTimeOffType
patch
Retrieve all PartnerTimeOffTypes
get
Retrieves a single PartnerTimeOffType
get
Mock Onboarding
Mock-onboard Employer
post
Mock-onboard Worker
post
Employer Onboarding
Retrieve list of HostedEmployerOnboarding
get
Create HostedEmployerOnboarding
post
Retrieve HostedEmployerOnboarding
get
Payroll Runs
Retrieve all PayrollRuns
get
Create PayrollRun
post
Preview PayrollRun
post
Delete PayrollRun
del
Retrieve PayrollRun
get
Confirm PayrollRun
post
Retrieve PayrollRun state
get
Retrieve all WorkerPaymentRecords
get
Modify a WorkerPayment
patch
Payroll Run Reports
Cash Requirements report
get
Payroll Journal report
get
Period Preview
Preview a period
post
Employer Reports
Payroll Journal report
post
Employer Signatories
Retrieve all Employer Signatories
get
Create a new Employer Signatory
post
Retrieve an Employer Signatory
get
Update an Employer Signatory
put
Employer Work Location
Retrieve work locations.
get
Retrieve a work location.
get
Work Weeks
Retrieve all EmployerWorkWeeks
get
Create EmployerWorkWeek
post
Delete EmployerWorkWeek
del
Retrieve EmployerWorkWeek
get
Update EmployerWorkWeek
patch
Worker Pay Groups
Retrieve all WorkerPayGroups
get
Create WorkerPayGroup
post
Delete WorkerPayGroup
del
Retrieve WorkerPayGroup
get
Update WorkerPayGroup
put
Worker Payments
Delete WorkerPayment
del
Retrieve WorkerPayment
get
Advance Payment
post
Get compensations
get
Creates compensation
put
Confirm WorkerPayment
post
Get deductions
get
Creates deduction
put
Get pay
get
Creates or updates pay for a particular worker payment
put
Get WorkerPaymentRecord
get
Retrieve WorkerPayments
get
Create WorkerPayment
post
Workers
Retrieve Workers
get
Create Worker
post
Delete Worker
del
Retrieve Worker
get
Update Worker
put
Worker Capabilities
Retrieve worker capabilities
get
Worker Contract
Retrieve WorkerContracts
get
Create WorkerContract
post
Update WorkerContract
patch
Worker Onboarding
Retrieve list of HostedWorkerOnboarding
get
Create HostedWorkerOnboarding
post
Retrieve HostedWorkerOnboarding
get
Worker Termination
Retrieve a worker termination.
get
Create a worker termination.
post
Delete a worker termination.
del
Update a worker termination.
put
Worker Work Location
Retrieve work locations
get
Retrieve a work location
get
Worker Payment Record
Retrieve all WorkerPaymentRecords
get
Organization Compensation Policy
Retrieve all OrganizationCompensationPolicies
get
Retrieve OrganizationCompensationPolicies
get
Deduction
Retrieve all PartnerDeductionTypes
get
Retrieve a single PartnerDeductionType
get
Paystream
Send Paystream item
post
Import Employers
post
Import payroll elements
post
Import employer risk metrics on partner platform
post
Import Workers
post
SSO Connection
Retrieve all SSO Connections
get
Retrieve SSO Connection by Id
get
Update SSO Connection
put
Usage
Retrieve all employers' usage metrics
get
Retrieve employer usage metrics
get
Webhook Endpoint
Retrieve all WebhookEndpoints
get
Create WebhookEndpoint
post
Retrieve WebhookEndpoint
get
Update WebhookEndpoint
put
Lifecycle Webhook Events
Triggers `AccountingConfiguration.created` when an accounting configuration is created for an employer.
post
Triggers `AccountingConfiguration.updated` when an accounting configuration is updated for an employer.
post
Triggers `Document.uploaded` when any document is uploaded for an Employer or Worker.
post
Triggers `Employer.AccountStanding.requirementsChanged` when an employer's account standing requirements change.
post
Triggers `Employer.AccountStanding.statusChanged` when an employer account standing status changes.
post
Triggers `Employer.Address.created` when an employer address is created.
post
Triggers `Employer.Address.deleted` when an employer address is deleted.
post
Triggers `Employer.Address.updated` when an employer address is updated.
post
Triggers `Employer.PayWorkersReadiness.requirementsChanged` when an employer's pay workers readiness requirements change.
post
Triggers `Employer.PayWorkersReadiness.statusChanged` when an employer pay workers readiness status changes.
post
Triggers `Employer.PayrollHistory.importCompleted` when the employer payroll history import from prior provider is completed.
post
Triggers `Employer.PayrollHistory.provided` when an employer's payroll history has been fully provided.
post
Triggers `Employer.PayrollHistory.required` when an employer declares that has payroll history in a prior provider to be imported.
post
Triggers `Employer.TaxesSetup.updated` when an employer's tax setup is updated.
post
Triggers `Employer.WorkerPayGroup.created` when a worker pay group is created.
post
Triggers `Employer.WorkerPayGroup.deleted` when a worker pay group is deleted.
post
Triggers `Employer.WorkerPayGroup.updated` when a worker pay group is updated.
post
Triggers `Employer.awaitingRiskInsights` when risk-insights data is required for risk evaluations.When you receive this event you must send all of the risk-insights data you have for the Employer within the payload.
post
Triggers `Employer.created` when an Employer is created.
post
Triggers `Employer.deleted` when an Employer is deleted.
post
Triggers `Employer.onboardingStatus` when an employer completes the onboarding form.
post
Triggers `Employer.updated` when an Employer is updated.
post
Triggers `EmployerBankAccount.Verification.statusChanged` when an EmployerBankAccountVerification status has changed.
post
Triggers `EmployerBankAccount.created` when an EmployerBankAccount is created.
post
Triggers `EmployerBankAccount.deleted` when an EmployerBankAccount is deleted.
post
Triggers `EmployerBankAccount.updated` when an EmployerBankAccount is updated.
post
Triggers `EmployerSignatory.created` when an employer signatory is created.
post
Triggers `EmployerSignatory.deleted` when an employer signatory is deleted.
post
Triggers `EmployerSignatory.updated` when an employer signatory is updated.
post
Triggers `PayrollRun.EmployerFunding.statusChanged` when the employer funding status for a payroll run has changed.
post
Triggers `PayrollRun.WorkerDisbursement.MoneyMovementTransaction.statusChanged` when a worker disbursement transaction status for a payroll run has changed.
post
Triggers `PayrollRun.awaitingInput` when compensation data is required for a payroll run. When you receive this event you must send all of the worker compensation data you have for the listed Workers within the interval provided. This data will be used to update the PayrollRun as an Employer is running payroll.
post
Triggers `PayrollRun.deleted` when a payroll run has been deleted.
post
Triggers `PayrollRun.statusChanged` when a payroll run status has changed.
post
Triggers `Transmission.completed` when a transmission is completed successfully.
post
Triggers `Transmission.failed` when a transmission fails.
post
Triggers `Transmission.processing` when a transmission is being processed.
post
Triggers `Worker.PaymentsReadiness.statusChanged` when an worker payments readiness status changes.
post
Triggers `Worker.Termination.statusChanged` when worker termination status changes.
post
Triggers `Worker.created` when a Worker is created.
post
Triggers `Worker.deleted` when a Worker is deleted.
post
Triggers `Worker.onboardingStatus` when the onboarding status for a worker changes, with possible statuses `INVITED`, `STARTED`, `COMPLETED`, and `INVALIDATED`.
post
Triggers `Worker.updated` when a Worker is updated.
post
Triggers `WorkerBankAccount.created` when a worker gets created.
post
Triggers `WorkerBankAccount.deleted` when a worker gets deleted.
post
Triggers `WorkerBankAccount.updated` when a worker gets updated.
post
Triggers `WorkerContract.created` when a Worker contract is created.
post
Triggers `WorkerContract.deleted` when a Worker contract is deleted.
post
Triggers `WorkerContract.updated` when a Worker contract is updated.
post
Triggers `WorkerPaymentDistribution.updated` when a worker's payment distribution rules are updated.
post
Triggers `WorkerPaymentAdjustment.created` when a worker payment adjustment gets created.
post
Triggers `WorkerPersonalInformation.created` when a Worker personal information is created.
post
Triggers `WorkerPersonalInformation.updated` when a Worker personal information is updated.
post
Notification Webhook Events
Triggers `Notification.Employer.taxRateUpdatedFromAgency` when an employer's tax rate is updated from agency data.
post
Triggers `Notification.EmployerBankAccount.microDepositVerificationCompleted` when a micro-deposit verification for an employer bank account has completed verification.
post
Triggers `Notification.EmployerBankAccount.microDepositVerificationFailed` when a micro-deposit verification for an employer bank account has failed.
post
Triggers `Notification.EmployerBankAccount.microDepositVerificationSent` when a micro-deposit verification for an employer bank account has been sent.
post
Triggers `Notification.EmployerBankAccount.paymentAuthorizationCompleted` when the payment authorization for the EmployerBankAccount is completed.
post
Triggers `Notification.Payment.employerFundingFailed` when the payment for an employer to fund a payroll run has failed.
post
Triggers `Notification.Payment.employerFundingRedebitCleared` when the payment for an employer redebit has cleared.
post
Triggers `Notification.Payment.employerFundingRescheduled` when the a redebit for an employer funding has been scheduled.
post
Triggers `Notification.Payment.workerDisbursementFailed` when the disbursement of a worker's pay fails.
post
Triggers `Notification.Payment.workerDisbursementRefundScheduled` when the disbursement for a worker payment is scheduled to be refunded to the Employer.
post
Triggers `Notification.Payment.workerDisbursementScheduled` when the disbursement for a worker payment is scheduled.
post
Triggers `Notification.employerPaydayReminder` 2 days before the employer has to confirm the next scheduled payroll run.
post
Triggers `Notification.employerPayrollHistoryRequired` when an employer declares that has payroll history in a prior provider to be imported.
post
Triggers `Notification.employerPayrollOperation` a generic endpoint, to send mass communication emails to employers.
post
Triggers `Notification.employerPayrollRunConfirmation` when an Employer confirms a payroll run.
post
Triggers `Notification.employerRegulatoryScreeningRequestForInformation` when an employer screening status change to REQUEST_FOR_INFORMATION.
post
Triggers `Notification.workerPayday` on the same day the worker is being paid. The event will be sent either at 1pm UTC or 11pm UTC of that day.
post
UI Experiences (Employer)
Employer dashboard
Run payroll
Employer onboarding
Employer setup personalization
Employer taxes setup
Employer sign documents
Employer pay groups
Employer onboard workers
Employer address list
Employer bank accounts
Employer profile
Worker profile
Onboard worker
Payroll runs list
Employer documents
UI Experiences (Worker)
Worker self onboarding
Worker self managed profile
Worker payments list
Worker documents
Salsa.js
Salsa.js Web SDK
Powered by
Retrieve all SSO Connections
Ask AI
get
https://api.sandbox.salsa.dev/api/rest/v1/sso
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
JWT
Bearer
URL
Base URL
https://api.sandbox.salsa.dev
/api/rest/v1/sso
Response
Click
Try It!
to start a request and see the response here!