Get the signed-in account
Returns the signed-in user and every carrier membership with its role.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Get the signed-in account › Responses
The signed-in account.
user_idemailfull_nameInvite a team member
Carrier admins only. Returns 201 for a new invitation and 200 when a pending invitation for the same email and role already exists.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Invite a team member › Request Body
email^(?:[A-Za-z0-9_'+\-]… · requiredrolefull_nameWho is invited, shown in the team list until they answer.
phoneTheir phone, to reach a driver before their phone is paired.
shipper_account_id^([0-9a-fA-F]{8}-[0-…Invite a team member › Responses
The pending invitation that already existed.
idemailroleshipper_account_idexpires_at^(?:(?:\d\d[2468][04… · requiredcreated_at^(?:(?:\d\d[2468][04… · requiredaccept_urlThe accept link, only in the response that minted the token and only on a stage that sends no invitation email (demo). Elsewhere the email is the only copy.
Accept an invitation
Without an Authorization header, creates the account with the given password and name. With one, adds the membership to the signed-in account and only the token is read. Answers 409 account_exists when the email already has an account: sign in, then accept again. Answers 409 invitation_for_another_account when the signed-in account is not the invited email.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Accept an invitation › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: token, password, full_name | |
| type = object · requires: token |
token^[A-Za-z0-9_-]{43}$ · requiredpassword(?=.*(?:(?=.*(?:[a-z… · requiredfull_namephoneA phone number. Six digits without a prefix are read as a New Caledonia number (+687).
Accept an invitation › Responses
The carrier and role granted.
carrier_idrolePreview an invitation
Public, with the token of the email. An unknown, expired, accepted or revoked token gives not_found.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Preview an invitation › Request Body
token^[A-Za-z0-9_-]{43}$ · requiredPreview an invitation › Responses
What the invited person sees before accepting.
emailfull_nameThe name the inviter gave, to fill in the form.
phoneE.164 format; the phone the inviter gave, to fill in the form.
roleshipper_account_nameinvited_by_nameNull when the platform sent the invitation.
created_at^(?:(?:\d\d[2468][04… · requiredexpires_at^(?:(?:\d\d[2468][04… · requiredDecline an invitation
Public, with the token of the email. The invitation is revoked and its link stops working.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Decline an invitation › Request Body
token^[A-Za-z0-9_-]{43}$ · requiredDecline an invitation › Responses
Done.