Skip to main content
GET
Who this key belongs to
Returns the principal behind the key: its role, and for carriers the verification and carrier record; for brokers the brokerage id and rep name. Works for both roles.

Authorizations

Authorization
string
header
required

One key per broker rep or per carrier signup. Keep it secret.

Response

The principal behind this key.

key_id
string<uuid>
required
key_prefix
string
required
Example:

"ls_live_1a2b"

role
enum<string>
required
Available options:
broker,
carrier
verification
enum<string>

Carriers only. verified: confirmed automatically (the signup email's domain matches an email on the carrier's record; shared mailbox domains such as ISP mail never count; the authority isn't shown as inactive) or by Lanesurf's team. needs_review: the carrier account is under review (trucks, lanes and the bid list only).

Available options:
verified,
needs_review
carrier
object

Carriers only. The carrier record from the identity check, and the contact proved with the code. Empty fields are left out.

broker_id
string<uuid>

Brokers only. The brokerage.

rep_name
string

Brokers only.