Human
A Human is a Worker who is a person, acting on Tasks through Apps, Mailboxes, and Channels.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
email | email | required | The address the Human signs in with. |
Inherited from Worker: 2 properties
| Property | Type | Required | Description |
|---|---|---|---|
name | string | required | The name the Worker goes by in a Startup. |
instructions | text | How the Worker does its work. |
Object
{
"$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, inversepays.
Verbs
createCreates a Human.POST /{namespace}/humansgetReturns one Human by id.GET /{namespace}/humans/{id}listReturns Humans, newest first, one page at a time.GET /{namespace}/humansupdateChanges the given properties of a Human.PATCH /{namespace}/humans/{id}deleteDeletes a Human; its history is kept.DELETE /{namespace}/humans/{id}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}/holdinviteInvite asks a person to join a Startup in a named Role, sharing that Role’s work with its Agent.POST /{namespace}/humans/inviteonboardOnboard admits a recruited Human to supply work once their identity, Credentials and payout details verify.POST /{namespace}/humans/{human}/onboardrecruitRecruit invites a person to supply credentialed work to a Startup through its supply App.POST /{namespace}/humans/recruitreleaseRelease frees a held amount for payout once its Dispute closes or its clearance period ends.POST /{namespace}/humans/{human}/releaseremitRemit pays a supplying Human’s earned balance to their bank account through the Startup’s payment account.POST /{namespace}/humans/{human}/remitsuspendSuspend stops a supplying Human from taking new Tasks while a Credential lapses or a dispute is open.POST /{namespace}/humans/{human}/suspend
Permissions
Which Access level may call each Verb. One-way Verbs wait their delay window.
| Operation | owner | admin | member | viewer |
|---|---|---|---|---|
Human.create | Yes | Yes | Yes | No |
Human.get | Yes | Yes | Yes | Yes |
Human.list | Yes | Yes | Yes | Yes |
Human.update | Yes | Yes | Yes | No |
Human.delete | Yes | Yes | Yes | No |
Human.hold | Yes | Yes | Yes | No |
Human.invite | Yes | Yes | Yes | No |
Human.onboard | Yes | Yes | Yes | No |
Human.recruit | Yes | Yes | Yes | No |
Human.release | Yes | Yes | Yes | No |
Human.remit | Yes | No | No | No |
Human.suspend | Yes | Yes | Yes | No |
Call it
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.