Onboarding

Get Admin Onboarding Data

Returns the org's admin onboarding record with company info, payment/funding config, masked bank account and flags.

GEThttps://api.toku.com/hris/get-admin-onboarding-data

Required scope: banking:read

curl --request GET \
  --url 'https://api.toku.com/hris/get-admin-onboarding-data' \
  --header 'Authorization: Bearer <token>'
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

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.

Response

200Successful response
isTokuAdminbooleanrequired
isMigrationOnboardingExemptbooleanrequired
allowsPayrollOnlybooleanrequired
hideTokuContractorbooleanrequired
loginEmailPolicyobjectrequired
Show child attributes
requirePersonalLoginEmailbooleanrequired
companyEmailDomainsstring[]required
completedStepsstring[]required
companyInfoobjectrequired
Show child attributes
legalNamestringrequired
tradingNamestringrequired
entityTypestringrequired
countrystringrequired
addressLine1stringrequired
addressLine2stringrequired
citystringrequired
stateProvincestringrequired
postalCodestringrequired
taxIdLastFourstringrequired
hiresUSEmployeesboolean | nullrequired
paymentConfigobjectrequired
Show child attributes
modestring | nullrequired
selectedTokenstring | nullrequired
selectedNetworkstring | nullrequired
selectedProductsstring[]required
fundingConfigobjectrequired
Show child attributes
bankSetupCompletebooleanrequired
cryptoFundingTypestring | nullrequired
orgBankAccountobject | nullrequired
Show child attributes
orgBankAccountIdstringrequired
bankCountryCodestringrequired
currencystringrequired
accountHolderNamestringrequired
bankNamestringrequired
accountTypestringrequired
accountNumberLastFourstringrequired
countryExtensionsobjectrequired
useForPlatformFeesbooleanrequired
verifiedbooleanrequired
canRevealOrgBankDetailsbooleanrequired
insuranceSelectionobjectrequired
Show child attributes
healthPlanstring | nullrequired
dentalPlanstring | nullrequired
businessVerificationCompletebooleanrequired
personaInquiryIdstring | nullrequired
stepSummariesobjectrequired
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits