Org settings, dashboards & reporting

Check Onboarding Item

Checks whether an onboarding step is in progress for a provider and upserts the state accordingly.

POSThttps://api.toku.com/stablecoin-payroll/check-onboarding-item

Not available to API keys yet. It will need organization:write.

curl --request POST \
  --url 'https://api.toku.com/stablecoin-payroll/check-onboarding-item' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "onboardingItem": "INVITE_ADMINS",
  "providerInformation": {
    "paymentIntegrationProvider": "string",
    "employeeSyncSource": "string",
    "payrollIntegrationType": "string"
  },
  "paymentIntegrationProvider": "BRIDGE",
  "employeeProvider": "CSV_UPLOAD",
  "payrollProvider": "CSV_UPLOAD"
}'
200 response
{
  "result": true
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is an access token from a Toku sign-in. See Authentication in the API reference.

Body

application/json

onboardingItemstringrequired

Available options: INVITE_ADMINS, SELECT_NETWORKS_AND_STABLECOINS, ADD_EMPLOYEES, INVITE_EMPLOYEES, ADD_PAYROLL_INTEGRATION, CONFIGURE_PAYROLL_SETTINGS, ADD_PAYMENT_INTEGRATION

providerInformationobject
Show child attributes
paymentIntegrationProviderstring

Allowed: 1 to 100 characters

employeeSyncSourcestring

Allowed: 1 to 100 characters

payrollIntegrationTypestring

Allowed: 1 to 100 characters

paymentIntegrationProviderstring

Available options: BRIDGE, FIREBLOCKS, SQUADS, COINBASE_PRIME, MANUAL

employeeProviderstring

Available options: CSV_UPLOAD, WORKDAY, ADP, UKG, TOKUEOR, TRINET, GUSTO, DEEL, BAMBOOHR, IMPORTED, OTHER

payrollProviderstring

Available options: CSV_UPLOAD, WORKDAY, ADP, UKG, TOKUEOR, TRINET, GUSTO, IMPORTED, OTHER

Response

200Successful response
resultbooleanrequired
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits