Onboarding
Get Company Admin Onboarding Data
Same as GetAdminOnboardingData but first requires company admin page view access.
POSThttps://api.toku.com/hris/get-company-admin-onboarding-data
Not available to API keys.
curl --request POST \
--url 'https://api.toku.com/hris/get-company-admin-onboarding-data' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'200 response
{
"isTokuAdmin": true,
"isMigrationOnboardingExempt": true,
"allowsPayrollOnly": true,
"hideTokuContractor": true,
"loginEmailPolicy": {
"requirePersonalLoginEmail": true,
"companyEmailDomains": [
"string"
]
},
"completedSteps": [
"string"
],
"companyInfo": {
"legalName": "string",
"tradingName": "string",
"entityType": "string",
"country": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"taxIdLastFour": "string",
"hiresUSEmployees": true
},
"paymentConfig": {
"mode": "string",
"selectedToken": "string",
"selectedNetwork": "string"
},
"selectedProducts": [
"string"
],
"fundingConfig": {
"bankSetupComplete": true,
"cryptoFundingType": "string"
},
"orgBankAccount": {
"orgBankAccountId": "string",
"bankCountryCode": "string",
"currency": "string",
"accountHolderName": "string",
"bankName": "string",
"accountType": "string",
"accountNumberLastFour": "string",
"countryExtensions": {},
"useForPlatformFees": true,
"verified": true
},
"canRevealOrgBankDetails": true,
"insuranceSelection": {
"healthPlan": "string",
"dentalPlan": "string"
},
"businessVerificationComplete": true,
"personaInquiryId": "string",
"stepSummaries": {}
}Authorizations
AuthorizationstringheaderrequiredBearer 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
Response
200Successful response
isTokuAdminbooleanrequiredisMigrationOnboardingExemptbooleanrequiredallowsPayrollOnlybooleanrequiredhideTokuContractorbooleanrequiredloginEmailPolicyobjectrequiredShow child attributes
requirePersonalLoginEmailbooleanrequiredcompanyEmailDomainsstring[]requiredcompletedStepsstring[]requiredcompanyInfoobjectrequiredShow child attributes
legalNamestringrequiredtradingNamestringrequiredentityTypestringrequiredcountrystringrequiredaddressLine1stringrequiredaddressLine2stringrequiredcitystringrequiredstateProvincestringrequiredpostalCodestringrequiredtaxIdLastFourstringrequiredhiresUSEmployeesboolean | nullrequiredpaymentConfigobjectrequiredShow child attributes
modestring | nullrequiredselectedTokenstring | nullrequiredselectedNetworkstring | nullrequiredselectedProductsstring[]requiredfundingConfigobjectrequiredShow child attributes
bankSetupCompletebooleanrequiredcryptoFundingTypestring | nullrequiredorgBankAccountobject | nullrequiredShow child attributes
orgBankAccountIdstringrequiredbankCountryCodestringrequiredcurrencystringrequiredaccountHolderNamestringrequiredbankNamestringrequiredaccountTypestringrequiredaccountNumberLastFourstringrequiredcountryExtensionsobjectrequireduseForPlatformFeesbooleanrequiredverifiedbooleanrequiredcanRevealOrgBankDetailsbooleanrequiredinsuranceSelectionobjectrequiredShow child attributes
healthPlanstring | nullrequireddentalPlanstring | nullrequiredbusinessVerificationCompletebooleanrequiredpersonaInquiryIdstring | nullrequiredstepSummariesobjectrequired400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits