People & profiles

Get Hris My Profile

Returns the full HRIS profile (personal, tax, masked banking, employment, documents, pending changes) for self or an employee.

GEThttps://api.toku.com/hris/get-hris-my-profile

Not available to API keys.

curl --request GET \
  --url 'https://api.toku.com/hris/get-hris-my-profile' \
  --header 'Authorization: Bearer <token>'
200 response
{
  "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

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.

Query parameters

roleInOrgIDstring<uuid>

Response

200Successful response
roleInOrgIDstringrequired
orgIDstringrequired
orgNamestringrequired
fullNamestringrequired
emailstringrequired
rolestringrequired
profileTypestringrequired

Available options: EMPLOYEE, CONTRACTOR, OTHER

statusstringrequired
titlestring | nullrequired
departmentstring | nullrequired
jobDescriptionstring | nullrequired
locationstring | nullrequired
startDatestring | nullrequired
probationEndDatestring | nullrequired
probationSelectedAtOnboardingbooleanrequired
probationRemovedbooleanrequired
endDatestring | nullrequired
terminationDatestring | nullrequired
benefitsEndDatestring | nullrequired
pendingTerminationobject | nullrequired
Show child attributes
statestringrequired

Available options: AWAITING_APPROVAL, SCHEDULED

effectiveDatestring | nullrequired
terminationTypestring | nullrequired
terminationSubReasonstring | nullrequired
terminationReasonstring | nullrequired
requestedByNamestring | nullrequired
requestedAtstring | nullrequired
terminationDetailsobject | nullrequired
Show child attributes
terminationTypestring | nullrequired
terminationSubReasonstring | nullrequired
terminationReasonstring | nullrequired
lastWorkingDaystring | nullrequired
lastDaystring | nullrequired
effectiveAtstring | nullrequired
ptoDaysTakenstring | nullrequired
ptoDaysRemainingstring | nullrequired
leavePolicyTypestring | nullrequired
ptoPayoutAtTerminationstring | nullrequired
severanceOfferedboolean | nullrequired
severanceDetailsstring | nullrequired
pilonDetailsstring | nullrequired
performancePlanboolean | nullrequired
performancePlanDetailsstring | nullrequired
benefitsEndDatestring | nullrequired
employeeInformedboolean | nullrequired
employeeInformedAtstring | nullrequired
alignmentConfirmedAtstring | nullrequired
leavePayoutFlagAcknowledgedAtstring | nullrequired
terminationLockobjectrequired
Show child attributes
isLockedbooleanrequired
canEditbooleanrequired
messagestring | nullrequired
isTerminatedbooleanrequired
managerNamestring | nullrequired
managerEmailstring | nullrequired
managerRoleInOrgIDstring | nullrequired
managerResolvedNamestring | nullrequired
phoneNumberstring | nullrequired
baseSalarystring | nullrequired
baseSalaryCurrencystring | nullrequired
baseSalaryPaymentTypestringrequired
baseSalaryTokenTypeIDstring | nullrequired
baseSalaryTokenSymbolstring | nullrequired
baseSalaryTokenNetworkstring | nullrequired
signOnBonusAmountstring | nullrequired
signOnBonusCurrencystring | nullrequired
employmentTypestring | nullrequired
employmentServiceTypestring | nullrequired
remoteHealthEligibleboolean | nullrequired
contractorTypestring | nullrequired
hideTokuContractorbooleanrequired
isPropTraderbooleanrequired
bankAccountPurposesEnabledbooleanrequired
contractingTypestring | nullrequired
agreementTypestring | nullrequired
fixedTermReasonstring | nullrequired
workSchedulestring | nullrequired
hoursPerWeekstring | nullrequired
ukDirectorStatusstring | nullrequired

Available options: Director, Non-Director, null

indiaProvidentFundobject | nullrequired
Show child attributes
contributionOptionstring | nullrequired

Available options: STANDARD, VOLUNTARY_HIGHER, null

deAssignmentLimitobject | nullrequired
Show child attributes
startDatestring | nullrequired
limitEndDatestring | nullrequired
historyUnconfirmedbooleanrequired
leaseSignatoryNamestring | nullrequired
leaseSignatoryEmailstring | nullrequired
canEditbooleanrequired
continuousServiceDatestring | nullrequired
continuousServiceBasisstring | nullrequired
payFrequencystring | nullrequired
contractEntityIDstring | nullrequired
contractEntityNamestring | nullrequired
contractEntitySourcestringrequired

Available options: assignment, country-default, legacy-strings, none

contractEntityAddressstring | nullrequired
contractEntityLocalNamestring | nullrequired
contractEntityRegistrationNumberstring | nullrequired
contractEntityCountryDefaultAmbiguousbooleanrequired
contractEntityHistoryobject[]required
Show child attributes
effectiveDatestring | nullrequired
entityNamestring | nullrequired
previousEntityNamestring | nullrequired
statestringrequired

Available options: APPLIED, SCHEDULED

countrystring | nullrequired
countryCodestringrequired
taxIdentityCountryCodestring | nullrequired
documentsobject[]required
Show child attributes
idstringrequired
categorystringrequired
displayNamestring | nullrequired
fileNamestringrequired
downloadUrlstring | nullrequired
createdAtstringrequired
signingStatusstring | nullrequired

Available options: NOT_SENT, AWAITING_SIGNATURE, AWAITING_COUNTERSIGNATURE, FINALIZING, SIGNED, DELIVERED, DECLINED, CANCELLED, VOIDED, EXPIRED, SUPERSEDED, null

documentSourcestring | nullrequired

Available options: ADMIN_UPLOAD, WORKER_UPLOAD, LEGACY_MIGRATION, LEGACY_SIGNED, LEGACY_VOIDED, LEGACY_DECLINED, LEGACY_UNSIGNED, null

uploadedByTokuAdminViaSpoofstring | nullrequired

Available options: AS_EMPLOYEE, AS_ADMIN, null

visibleToEmployeeboolean | nullrequired
visibleToClientAdminsboolean | nullrequired
bankAccountsobject[]required
Show child attributes
bankAccountHolderAddressobject
Show child attributes
line1string | nullrequired
line2string | nullrequired
line3string | nullrequired
citystring | nullrequired
statestring | nullrequired
postalCodestring | nullrequired
countrystring | nullrequired
bankAddressobject
Show child attributes
line1string | nullrequired
line2string | nullrequired
line3string | nullrequired
citystring | nullrequired
statestring | nullrequired
postalCodestring | nullrequired
countrystring | nullrequired
hrisBankAccountIDstringrequired
countryCodestringrequired
currencyCodestring | nullrequired
isPrimarybooleanrequired
bankIfscCodestring | nullrequired
bankSortCodestring | nullrequired
bankBsbstring | nullrequired
bankTransitNumberstring | nullrequired
bankInstitutionNumberstring | nullrequired
bankClabestring | nullrequired
bankCodestring | nullrequired
bankBranchCodestring | nullrequired
bankCpfNumberstring | nullrequired
bankPixKeystring | nullrequired
bankAccountHolderNamestring | nullrequired
bankNamestring | nullrequired
bankAccountTypestring | nullrequired
accountProviderstring | null
payoutPurposestring | null

Available options: INVOICE_FEES, EXPENSE_REIMBURSEMENTS, null

bankAccountNumberstring | nullrequired
bankAccountNumberLastFourstring | nullrequired
bankRoutingNumberstring | nullrequired
bankIbanstring | nullrequired
bankIbanLastFourstring | nullrequired
bankBicSwiftCodestring | nullrequired
bankBicSwiftCodeLastFourstring | nullrequired
bankBranchstring | nullrequired
archivedBankAccountsobject[]required
Show child attributes
hrisBankAccountIdstringrequired
bankNamestring | nullrequired
accountNumberLastFourstring | nullrequired
deletedAtstring | nullrequired
onboardingDataobject | nullrequired
Show child attributes
businessEntityobject | nullrequired
Show child attributes
contractingTypestring | nullrequired
entityNamestring | nullrequired
entityRegisteredAddressstring | nullrequired
entityCountrystring | nullrequired
entityTypestring | nullrequired
entityTaxIdstring | nullrequired
entityTaxIdNeedsReentrybooleanrequired
preferredNamestring | nullrequired
dateOfBirthstring | nullrequired
genderstring | nullrequired
maritalStatusstring | nullrequired
nationalitystring | nullrequired
additionalCitizenshipstring | nullrequired
personalEmailstring | nullrequired
addressobject | nullrequired
Show child attributes
line1string | nullrequired
line2string | nullrequired
citystring | nullrequired
statestring | nullrequired
postalCodestring | nullrequired
countrystring | nullrequired
emergencyContactobject | nullrequired
Show child attributes
namestring | nullrequired
relationshipstring | nullrequired
phonestring | nullrequired
emailstring | nullrequired
workAuthobject | nullrequired
Show child attributes
authorizationTypestring | nullrequired
authorizationSubTypestring | nullrequired
authorizationEvidenceTypestring | nullrequired
expiryDatestring | nullrequired
sponsorshipRequestedboolean | nullrequired
sponsorshipNotesstring | nullrequired
documentLastFourstring | nullrequired
verificationConsentboolean | nullrequired
statusstring | nullrequired
workAuthStatusstring | nullrequired
visaTypestring | nullrequired
visaExpiryDatestring | nullrequired
immigrationSupportRequestedboolean | nullrequired
immigrationSupportNotesstring | nullrequired
taxobject | nullrequired
Show child attributes
taxIdTypestring | nullrequired
taxIdLastFourstring | nullrequired
nationalIdTypestring | nullrequired
nationalIdLastFourstring | nullrequired
w4FilingStatusstring | nullrequired
stateTaxWithholdingStatestring | nullrequired
i9CitizenshipStatusstring | nullrequired
ssnLastFourstring | nullrequired
bankingobject | nullrequired
Show child attributes
countryCodestring | nullrequired
bankIfscCodestring | nullrequired
bankSortCodestring | nullrequired
bankBsbstring | nullrequired
bankTransitNumberstring | nullrequired
bankInstitutionNumberstring | nullrequired
bankClabestring | nullrequired
bankCodestring | nullrequired
bankBranchCodestring | nullrequired
bankCpfNumberstring | nullrequired
bankPixKeystring | nullrequired
bankAccountHolderNamestring | nullrequired
bankNamestring | nullrequired
bankAccountTypestring | nullrequired
bankAccountNumberstring | nullrequired
bankAccountNumberLastFourstring | nullrequired
bankRoutingNumberstring | nullrequired
bankIbanstring | nullrequired
bankIbanLastFourstring | nullrequired
bankBicSwiftCodestring | nullrequired
bankBicSwiftCodeLastFourstring | nullrequired
bankBranchstring | nullrequired
bankAccountHolderAddressobject | nullrequired
Show child attributes
line1string | nullrequired
line2string | nullrequired
line3string | nullrequired
citystring | nullrequired
statestring | nullrequired
postalCodestring | nullrequired
countrystring | nullrequired
bankAddressobject | nullrequired
Show child attributes
line1string | nullrequired
line2string | nullrequired
line3string | nullrequired
citystring | nullrequired
statestring | nullrequired
postalCodestring | nullrequired
countrystring | nullrequired
cryptoWalletAddressstring | nullrequired
cryptoWalletChainstring | nullrequired
cryptoWalletChainIconstring | null
cryptoWalletStablecoinstring | nullrequired
cryptoWalletStablecoinIconstring | null
cryptoPaymentAmountstring | nullrequired
otherCryptoWalletAddressesstring[]
benefitsobject | nullrequired
Show child attributes
medicalstring | nullrequired
dentalstring | nullrequired
visionstring | nullrequired
retirement401kstring | nullrequired
lifeInsurancestring | nullrequired
documentsobject[]required
Show child attributes
idstringrequired
categorystringrequired
displayNamestring | nullrequired
fileNamestringrequired
createdAtstringrequired
dataConsentGivenbooleanrequired
employmentAgreementSignedbooleanrequired
handbookAcknowledgedbooleanrequired
pendingChangesobjectrequired
scheduledChangesobject[]required
Show child attributes
changeRequestIdstringrequired
categorystringrequired
statusstringrequired

Available options: PENDING, SCHEDULED

changesobjectrequired
effectiveDatestring | nullrequired
requestedAtstringrequired
requestedByNamestringrequired
canCancelbooleanrequired
skeletonobjectrequired
Show child attributes
personalDetailsReadybooleanrequired
compensationReadybooleanrequired
documentsReadybooleanrequired
kotaEmployeeIDinteger | null
kotaBenefitsStatusobject | null
Show child attributes
enrollmentStatusstringrequired
offboardingStatusstringrequired
hasKotaEmployeeIDbooleanrequired
benefitsBannerDismissedAtstring | null
countryHasQuotaBenefitsbooleanrequired
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits