Skip to content

Human

A Human is a Worker who is a person, acting on Tasks through Apps, Mailboxes, and Channels.

Properties

PropertyTypeRequiredDescription
emailemailrequiredThe address the Human signs in with.
Inherited from Worker: 2 properties
PropertyTypeRequiredDescription
namestringrequiredThe name the Worker goes by in a Startup.
instructionstextHow the Worker does its work.

Object

JSON
{
  "$id": "https://api.sb/ledgerlark.com/humans/human_1",
  "$type": "Human",
  "name": "LedgerLark",
  "instructions": "Example instructions",
  "email": "priya@ledgerlark.com"
}

Relationships

  • A Human is paid in many Pay Runs: a Pay Run pays the Humans the Company employs; each employee appears in one run per pay period. paidIn, inverse pays.

Verbs

  1. createCreates a Human.
    POST /{namespace}/humansdoHuman.created
  2. getReturns one Human by id.
    GET /{namespace}/humans/{id}readNo Event
  3. listReturns Humans, newest first, one page at a time.
    GET /{namespace}/humansreadNo Event
  4. updateChanges the given properties of a Human.
    PATCH /{namespace}/humans/{id}doHuman.updated
  5. deleteDeletes a Human; its history is kept.
    DELETE /{namespace}/humans/{id}doHuman.deleted
  6. holdHold sets aside part of a supplying Human’s earned balance against an open Dispute or an Order inside its clearance period.
    POST /{namespace}/humans/{human}/holddoHuman.held
  7. inviteInvite asks a person to join a Startup in a named Role, sharing that Role’s work with its Agent.
    POST /{namespace}/humans/invitedoHuman.invited
  8. onboardOnboard admits a recruited Human to supply work once their identity, Credentials and payout details verify.
    POST /{namespace}/humans/{human}/onboarddoHuman.onboarded
  9. recruitRecruit invites a person to supply credentialed work to a Startup through its supply App.
    POST /{namespace}/humans/recruitdoHuman.recruited
  10. releaseRelease frees a held amount for payout once its Dispute closes or its clearance period ends.
    POST /{namespace}/humans/{human}/releasedoHuman.released
  11. remitRemit pays a supplying Human’s earned balance to their bank account through the Startup’s payment account.
    POST /{namespace}/humans/{human}/remitdoHuman.remitted
  12. suspendSuspend stops a supplying Human from taking new Tasks while a Credential lapses or a dispute is open.
    POST /{namespace}/humans/{human}/suspenddoHuman.suspended

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operationowneradminmemberviewer
Human.createYesYesYesNo
Human.getYesYesYesYes
Human.listYesYesYesYes
Human.updateYesYesYesNo
Human.deleteYesYesYesNo
Human.holdYesYesYesNo
Human.inviteYesYesYesNo
Human.onboardYesYesYesNo
Human.recruitYesYesYesNo
Human.releaseYesYesYesNo
Human.remitYesNoNoNo
Human.suspendYesYesYesNo

Call it

Text
Remit Lena Fischer.

Example

A certified court translator is a Human who fills a reviewer Role at a translation marketplace. She works Tasks in the App, and only she signs each certification.