People & profiles
Get Hris My Profile
Returns the full HRIS profile (personal, tax, masked banking, employment, documents, pending changes) for self or an employee.
Not available to API keys.
curl --request GET \
--url 'https://api.toku.com/hris/get-hris-my-profile' \
--header 'Authorization: Bearer <token>'{
"roleInOrgID": "string",
"orgID": "string",
"orgName": "string",
"fullName": "string",
"email": "string",
"role": "string",
"profileType": "EMPLOYEE",
"status": "string",
"title": "string",
"department": "string",
"jobDescription": "string",
"location": "string",
"startDate": "string",
"probationEndDate": "string",
"probationSelectedAtOnboarding": true,
"probationRemoved": true,
"endDate": "string",
"terminationDate": "string",
"benefitsEndDate": "string",
"pendingTermination": {
"state": "AWAITING_APPROVAL",
"effectiveDate": "string",
"terminationType": "string",
"terminationSubReason": "string",
"terminationReason": "string",
"requestedByName": "string",
"requestedAt": "string"
},
"terminationDetails": {
"terminationType": "string",
"terminationSubReason": "string",
"terminationReason": "string",
"lastWorkingDay": "string",
"lastDay": "string",
"effectiveAt": "string",
"ptoDaysTaken": "string",
"ptoDaysRemaining": "string",
"leavePolicyType": "string",
"ptoPayoutAtTermination": "string",
"severanceOffered": true,
"severanceDetails": "string",
"pilonDetails": "string",
"performancePlan": true,
"performancePlanDetails": "string",
"benefitsEndDate": "string",
"employeeInformed": true,
"employeeInformedAt": "string",
"alignmentConfirmedAt": "string",
"leavePayoutFlagAcknowledgedAt": "string"
},
"terminationLock": {
"isLocked": true,
"canEdit": true,
"message": "string"
},
"isTerminated": true,
"managerName": "string",
"managerEmail": "string",
"managerRoleInOrgID": "string",
"managerResolvedName": "string",
"phoneNumber": "string",
"baseSalary": "string",
"baseSalaryCurrency": "string",
"baseSalaryPaymentType": "string",
"baseSalaryTokenTypeID": "string",
"baseSalaryTokenSymbol": "string",
"baseSalaryTokenNetwork": "string",
"signOnBonusAmount": "string",
"signOnBonusCurrency": "string",
"employmentType": "string",
"employmentServiceType": "string",
"remoteHealthEligible": true,
"contractorType": "string",
"hideTokuContractor": true,
"isPropTrader": true,
"bankAccountPurposesEnabled": true,
"contractingType": "string",
"agreementType": "string",
"fixedTermReason": "string",
"workSchedule": "string",
"hoursPerWeek": "string",
"ukDirectorStatus": "Director",
"indiaProvidentFund": {
"contributionOption": "STANDARD"
},
"deAssignmentLimit": {
"startDate": "string",
"limitEndDate": "string",
"historyUnconfirmed": true,
"leaseSignatoryName": "string",
"leaseSignatoryEmail": "string",
"canEdit": true
},
"continuousServiceDate": "string",
"continuousServiceBasis": "string",
"payFrequency": "string",
"contractEntityID": "string",
"contractEntityName": "string",
"contractEntitySource": "assignment",
"contractEntityAddress": "string",
"contractEntityLocalName": "string",
"contractEntityRegistrationNumber": "string",
"contractEntityCountryDefaultAmbiguous": true,
"contractEntityHistory": [
{
"effectiveDate": "string",
"entityName": "string",
"previousEntityName": "string",
"state": "APPLIED"
}
],
"country": "string",
"countryCode": "string",
"taxIdentityCountryCode": "string",
"documents": [
{
"id": "string",
"category": "string",
"displayName": "string",
"fileName": "string",
"downloadUrl": "string",
"createdAt": "string",
"signingStatus": "NOT_SENT",
"documentSource": "ADMIN_UPLOAD",
"uploadedByTokuAdminViaSpoof": "AS_EMPLOYEE",
"visibleToEmployee": true,
"visibleToClientAdmins": true
}
],
"bankAccounts": [
{
"bankAccountHolderAddress": {
"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string"
},
"bankAddress": {
"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string"
},
"hrisBankAccountID": "string",
"countryCode": "string",
"currencyCode": "string",
"isPrimary": true,
"bankIfscCode": "string",
"bankSortCode": "string",
"bankBsb": "string",
"bankTransitNumber": "string",
"bankInstitutionNumber": "string",
"bankClabe": "string",
"bankCode": "string",
"bankBranchCode": "string",
"bankCpfNumber": "string",
"bankPixKey": "string",
"bankAccountHolderName": "string",
"bankName": "string",
"bankAccountType": "string",
"accountProvider": "string",
"payoutPurpose": "INVOICE_FEES",
"bankAccountNumber": "string",
"bankAccountNumberLastFour": "string",
"bankRoutingNumber": "string",
"bankIban": "string",
"bankIbanLastFour": "string",
"bankBicSwiftCode": "string",
"bankBicSwiftCodeLastFour": "string",
"bankBranch": "string"
}
],
"archivedBankAccounts": [
{
"hrisBankAccountId": "string",
"bankName": "string",
"accountNumberLastFour": "string",
"deletedAt": "string"
}
],
"onboardingData": {
"businessEntity": {
"contractingType": "string",
"entityName": "string",
"entityRegisteredAddress": "string",
"entityCountry": "string",
"entityType": "string",
"entityTaxId": "string",
"entityTaxIdNeedsReentry": true
},
"preferredName": "string",
"dateOfBirth": "string",
"gender": "string",
"maritalStatus": "string",
"nationality": "string",
"additionalCitizenship": "string",
"personalEmail": "string",
"address": {
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string"
},
"emergencyContact": {
"name": "string",
"relationship": "string",
"phone": "string",
"email": "string"
},
"workAuth": {
"authorizationType": "string",
"authorizationSubType": "string",
"authorizationEvidenceType": "string",
"expiryDate": "string",
"sponsorshipRequested": true,
"sponsorshipNotes": "string",
"documentLastFour": "string",
"verificationConsent": true,
"status": "string",
"workAuthStatus": "string",
"visaType": "string",
"visaExpiryDate": "string",
"immigrationSupportRequested": true,
"immigrationSupportNotes": "string"
},
"tax": {
"taxIdType": "string",
"taxIdLastFour": "string",
"nationalIdType": "string",
"nationalIdLastFour": "string",
"w4FilingStatus": "string",
"stateTaxWithholdingState": "string",
"i9CitizenshipStatus": "string",
"ssnLastFour": "string"
},
"banking": {
"countryCode": "string",
"bankIfscCode": "string",
"bankSortCode": "string",
"bankBsb": "string",
"bankTransitNumber": "string",
"bankInstitutionNumber": "string",
"bankClabe": "string",
"bankCode": "string",
"bankBranchCode": "string",
"bankCpfNumber": "string",
"bankPixKey": "string",
"bankAccountHolderName": "string",
"bankName": "string",
"bankAccountType": "string",
"bankAccountNumber": "string",
"bankAccountNumberLastFour": "string",
"bankRoutingNumber": "string",
"bankIban": "string",
"bankIbanLastFour": "string",
"bankBicSwiftCode": "string",
"bankBicSwiftCodeLastFour": "string",
"bankBranch": "string",
"bankAccountHolderAddress": {
"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string"
},
"bankAddress": {
"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string"
},
"cryptoWalletAddress": "string",
"cryptoWalletChain": "string",
"cryptoWalletChainIcon": "string",
"cryptoWalletStablecoin": "string",
"cryptoWalletStablecoinIcon": "string",
"cryptoPaymentAmount": "string",
"otherCryptoWalletAddresses": [
"string"
]
},
"benefits": {
"medical": "string",
"dental": "string",
"vision": "string",
"retirement401k": "string",
"lifeInsurance": "string"
},
"documents": [
{
"id": "string",
"category": "string",
"displayName": "string",
"fileName": "string",
"createdAt": "string"
}
],
"dataConsentGiven": true,
"employmentAgreementSigned": true,
"handbookAcknowledged": true
},
"pendingChanges": {},
"scheduledChanges": [
{
"changeRequestId": "string",
"category": "string",
"status": "PENDING",
"changes": {},
"effectiveDate": "string",
"requestedAt": "string",
"requestedByName": "string",
"canCancel": true
}
],
"skeleton": {
"personalDetailsReady": true,
"compensationReady": true,
"documentsReady": true
},
"kotaEmployeeID": 0,
"kotaBenefitsStatus": {
"enrollmentStatus": "string",
"offboardingStatus": "string",
"hasKotaEmployeeID": true,
"benefitsBannerDismissedAt": "string",
"countryHasQuotaBenefits": true
}
}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.
Query parameters
roleInOrgIDstring<uuid>Response
200Successful response
roleInOrgIDstringrequiredorgIDstringrequiredorgNamestringrequiredfullNamestringrequiredemailstringrequiredrolestringrequiredprofileTypestringrequiredAvailable options: EMPLOYEE, CONTRACTOR, OTHER
statusstringrequiredtitlestring | nullrequireddepartmentstring | nullrequiredjobDescriptionstring | nullrequiredlocationstring | nullrequiredstartDatestring | nullrequiredprobationEndDatestring | nullrequiredprobationSelectedAtOnboardingbooleanrequiredprobationRemovedbooleanrequiredendDatestring | nullrequiredterminationDatestring | nullrequiredbenefitsEndDatestring | nullrequiredpendingTerminationobject | nullrequiredShow child attributes
statestringrequiredAvailable options: AWAITING_APPROVAL, SCHEDULED
effectiveDatestring | nullrequiredterminationTypestring | nullrequiredterminationSubReasonstring | nullrequiredterminationReasonstring | nullrequiredrequestedByNamestring | nullrequiredrequestedAtstring | nullrequiredterminationDetailsobject | nullrequiredShow child attributes
terminationTypestring | nullrequiredterminationSubReasonstring | nullrequiredterminationReasonstring | nullrequiredlastWorkingDaystring | nullrequiredlastDaystring | nullrequiredeffectiveAtstring | nullrequiredptoDaysTakenstring | nullrequiredptoDaysRemainingstring | nullrequiredleavePolicyTypestring | nullrequiredptoPayoutAtTerminationstring | nullrequiredseveranceOfferedboolean | nullrequiredseveranceDetailsstring | nullrequiredpilonDetailsstring | nullrequiredperformancePlanboolean | nullrequiredperformancePlanDetailsstring | nullrequiredbenefitsEndDatestring | nullrequiredemployeeInformedboolean | nullrequiredemployeeInformedAtstring | nullrequiredalignmentConfirmedAtstring | nullrequiredleavePayoutFlagAcknowledgedAtstring | nullrequiredterminationLockobjectrequiredShow child attributes
isLockedbooleanrequiredcanEditbooleanrequiredmessagestring | nullrequiredisTerminatedbooleanrequiredmanagerNamestring | nullrequiredmanagerEmailstring | nullrequiredmanagerRoleInOrgIDstring | nullrequiredmanagerResolvedNamestring | nullrequiredphoneNumberstring | nullrequiredbaseSalarystring | nullrequiredbaseSalaryCurrencystring | nullrequiredbaseSalaryPaymentTypestringrequiredbaseSalaryTokenTypeIDstring | nullrequiredbaseSalaryTokenSymbolstring | nullrequiredbaseSalaryTokenNetworkstring | nullrequiredsignOnBonusAmountstring | nullrequiredsignOnBonusCurrencystring | nullrequiredemploymentTypestring | nullrequiredemploymentServiceTypestring | nullrequiredremoteHealthEligibleboolean | nullrequiredcontractorTypestring | nullrequiredhideTokuContractorbooleanrequiredisPropTraderbooleanrequiredbankAccountPurposesEnabledbooleanrequiredcontractingTypestring | nullrequiredagreementTypestring | nullrequiredfixedTermReasonstring | nullrequiredworkSchedulestring | nullrequiredhoursPerWeekstring | nullrequiredukDirectorStatusstring | nullrequiredAvailable options: Director, Non-Director, null
indiaProvidentFundobject | nullrequiredShow child attributes
contributionOptionstring | nullrequiredAvailable options: STANDARD, VOLUNTARY_HIGHER, null
deAssignmentLimitobject | nullrequiredShow child attributes
startDatestring | nullrequiredlimitEndDatestring | nullrequiredhistoryUnconfirmedbooleanrequiredleaseSignatoryNamestring | nullrequiredleaseSignatoryEmailstring | nullrequiredcanEditbooleanrequiredcontinuousServiceDatestring | nullrequiredcontinuousServiceBasisstring | nullrequiredpayFrequencystring | nullrequiredcontractEntityIDstring | nullrequiredcontractEntityNamestring | nullrequiredcontractEntitySourcestringrequiredAvailable options: assignment, country-default, legacy-strings, none
contractEntityAddressstring | nullrequiredcontractEntityLocalNamestring | nullrequiredcontractEntityRegistrationNumberstring | nullrequiredcontractEntityCountryDefaultAmbiguousbooleanrequiredcontractEntityHistoryobject[]requiredShow child attributes
effectiveDatestring | nullrequiredentityNamestring | nullrequiredpreviousEntityNamestring | nullrequiredstatestringrequiredAvailable options: APPLIED, SCHEDULED
countrystring | nullrequiredcountryCodestringrequiredtaxIdentityCountryCodestring | nullrequireddocumentsobject[]requiredShow child attributes
idstringrequiredcategorystringrequireddisplayNamestring | nullrequiredfileNamestringrequireddownloadUrlstring | nullrequiredcreatedAtstringrequiredsigningStatusstring | nullrequiredAvailable options: NOT_SENT, AWAITING_SIGNATURE, AWAITING_COUNTERSIGNATURE, FINALIZING, SIGNED, DELIVERED, DECLINED, CANCELLED, VOIDED, EXPIRED, SUPERSEDED, null
documentSourcestring | nullrequiredAvailable options: ADMIN_UPLOAD, WORKER_UPLOAD, LEGACY_MIGRATION, LEGACY_SIGNED, LEGACY_VOIDED, LEGACY_DECLINED, LEGACY_UNSIGNED, null
uploadedByTokuAdminViaSpoofstring | nullrequiredAvailable options: AS_EMPLOYEE, AS_ADMIN, null
visibleToEmployeeboolean | nullrequiredvisibleToClientAdminsboolean | nullrequiredbankAccountsobject[]requiredShow child attributes
bankAccountHolderAddressobjectShow child attributes
line1string | nullrequiredline2string | nullrequiredline3string | nullrequiredcitystring | nullrequiredstatestring | nullrequiredpostalCodestring | nullrequiredcountrystring | nullrequiredbankAddressobjectShow child attributes
line1string | nullrequiredline2string | nullrequiredline3string | nullrequiredcitystring | nullrequiredstatestring | nullrequiredpostalCodestring | nullrequiredcountrystring | nullrequiredhrisBankAccountIDstringrequiredcountryCodestringrequiredcurrencyCodestring | nullrequiredisPrimarybooleanrequiredbankIfscCodestring | nullrequiredbankSortCodestring | nullrequiredbankBsbstring | nullrequiredbankTransitNumberstring | nullrequiredbankInstitutionNumberstring | nullrequiredbankClabestring | nullrequiredbankCodestring | nullrequiredbankBranchCodestring | nullrequiredbankCpfNumberstring | nullrequiredbankPixKeystring | nullrequiredbankAccountHolderNamestring | nullrequiredbankNamestring | nullrequiredbankAccountTypestring | nullrequiredaccountProviderstring | nullpayoutPurposestring | nullAvailable options: INVOICE_FEES, EXPENSE_REIMBURSEMENTS, null
bankAccountNumberstring | nullrequiredbankAccountNumberLastFourstring | nullrequiredbankRoutingNumberstring | nullrequiredbankIbanstring | nullrequiredbankIbanLastFourstring | nullrequiredbankBicSwiftCodestring | nullrequiredbankBicSwiftCodeLastFourstring | nullrequiredbankBranchstring | nullrequiredarchivedBankAccountsobject[]requiredShow child attributes
hrisBankAccountIdstringrequiredbankNamestring | nullrequiredaccountNumberLastFourstring | nullrequireddeletedAtstring | nullrequiredonboardingDataobject | nullrequiredShow child attributes
businessEntityobject | nullrequiredShow child attributes
contractingTypestring | nullrequiredentityNamestring | nullrequiredentityRegisteredAddressstring | nullrequiredentityCountrystring | nullrequiredentityTypestring | nullrequiredentityTaxIdstring | nullrequiredentityTaxIdNeedsReentrybooleanrequiredpreferredNamestring | nullrequireddateOfBirthstring | nullrequiredgenderstring | nullrequiredmaritalStatusstring | nullrequirednationalitystring | nullrequiredadditionalCitizenshipstring | nullrequiredpersonalEmailstring | nullrequiredaddressobject | nullrequiredShow child attributes
line1string | nullrequiredline2string | nullrequiredcitystring | nullrequiredstatestring | nullrequiredpostalCodestring | nullrequiredcountrystring | nullrequiredemergencyContactobject | nullrequiredShow child attributes
namestring | nullrequiredrelationshipstring | nullrequiredphonestring | nullrequiredemailstring | nullrequiredworkAuthobject | nullrequiredShow child attributes
authorizationTypestring | nullrequiredauthorizationSubTypestring | nullrequiredauthorizationEvidenceTypestring | nullrequiredexpiryDatestring | nullrequiredsponsorshipRequestedboolean | nullrequiredsponsorshipNotesstring | nullrequireddocumentLastFourstring | nullrequiredverificationConsentboolean | nullrequiredstatusstring | nullrequiredworkAuthStatusstring | nullrequiredvisaTypestring | nullrequiredvisaExpiryDatestring | nullrequiredimmigrationSupportRequestedboolean | nullrequiredimmigrationSupportNotesstring | nullrequiredtaxobject | nullrequiredShow child attributes
taxIdTypestring | nullrequiredtaxIdLastFourstring | nullrequirednationalIdTypestring | nullrequirednationalIdLastFourstring | nullrequiredw4FilingStatusstring | nullrequiredstateTaxWithholdingStatestring | nullrequiredi9CitizenshipStatusstring | nullrequiredssnLastFourstring | nullrequiredbankingobject | nullrequiredShow child attributes
countryCodestring | nullrequiredbankIfscCodestring | nullrequiredbankSortCodestring | nullrequiredbankBsbstring | nullrequiredbankTransitNumberstring | nullrequiredbankInstitutionNumberstring | nullrequiredbankClabestring | nullrequiredbankCodestring | nullrequiredbankBranchCodestring | nullrequiredbankCpfNumberstring | nullrequiredbankPixKeystring | nullrequiredbankAccountHolderNamestring | nullrequiredbankNamestring | nullrequiredbankAccountTypestring | nullrequiredbankAccountNumberstring | nullrequiredbankAccountNumberLastFourstring | nullrequiredbankRoutingNumberstring | nullrequiredbankIbanstring | nullrequiredbankIbanLastFourstring | nullrequiredbankBicSwiftCodestring | nullrequiredbankBicSwiftCodeLastFourstring | nullrequiredbankBranchstring | nullrequiredbankAccountHolderAddressobject | nullrequiredShow child attributes
line1string | nullrequiredline2string | nullrequiredline3string | nullrequiredcitystring | nullrequiredstatestring | nullrequiredpostalCodestring | nullrequiredcountrystring | nullrequiredbankAddressobject | nullrequiredShow child attributes
line1string | nullrequiredline2string | nullrequiredline3string | nullrequiredcitystring | nullrequiredstatestring | nullrequiredpostalCodestring | nullrequiredcountrystring | nullrequiredcryptoWalletAddressstring | nullrequiredcryptoWalletChainstring | nullrequiredcryptoWalletChainIconstring | nullcryptoWalletStablecoinstring | nullrequiredcryptoWalletStablecoinIconstring | nullcryptoPaymentAmountstring | nullrequiredotherCryptoWalletAddressesstring[]benefitsobject | nullrequiredShow child attributes
medicalstring | nullrequireddentalstring | nullrequiredvisionstring | nullrequiredretirement401kstring | nullrequiredlifeInsurancestring | nullrequireddocumentsobject[]requiredShow child attributes
idstringrequiredcategorystringrequireddisplayNamestring | nullrequiredfileNamestringrequiredcreatedAtstringrequireddataConsentGivenbooleanrequiredemploymentAgreementSignedbooleanrequiredhandbookAcknowledgedbooleanrequiredpendingChangesobjectrequiredscheduledChangesobject[]requiredShow child attributes
changeRequestIdstringrequiredcategorystringrequiredstatusstringrequiredAvailable options: PENDING, SCHEDULED
changesobjectrequiredeffectiveDatestring | nullrequiredrequestedAtstringrequiredrequestedByNamestringrequiredcanCancelbooleanrequiredskeletonobjectrequiredShow child attributes
personalDetailsReadybooleanrequiredcompensationReadybooleanrequireddocumentsReadybooleanrequiredkotaEmployeeIDinteger | nullkotaBenefitsStatusobject | nullShow child attributes
enrollmentStatusstringrequiredoffboardingStatusstringrequiredhasKotaEmployeeIDbooleanrequiredbenefitsBannerDismissedAtstring | nullcountryHasQuotaBenefitsbooleanrequired