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.
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).
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Lanesurf Agent API","description":"Let any AI agent get a freight load covered, or get a truck loaded, through Lanesurf.","colors":{"primary":"#2563EB","light":"#60A5FA","dark":"#1D4ED8"},"logo":{"light":"https://mintcdn.com/lanesurf-d98c59ed/XupxBXiERw20rl0s/logo/light.svg?fit=max\u0026auto=format\u0026n=XupxBXiERw20rl0s\u0026q=85\u0026s=e7e783e919601573a03ed1dcf02233f8","dark":"https://mintcdn.com/lanesurf-d98c59ed/XupxBXiERw20rl0s/logo/dark.svg?fit=max\u0026auto=format\u0026n=XupxBXiERw20rl0s\u0026q=85\u0026s=9c19154496fe52a5616ae0d98c489570","href":"/"},"favicon":"https://mintcdn.com/lanesurf-d98c59ed/XupxBXiERw20rl0s/favicon.png?fit=max\u0026auto=format\u0026n=XupxBXiERw20rl0s\u0026q=85\u0026s=f2c5b6e71d9aaa614f7f04cfa13d3e21","navbar":{"links":[{"href":"mailto:support@lanesurf.com","label":"Support"},{"href":"https://www.lanesurf.com","label":"lanesurf.com"}]},"footer":{"socials":{"website":"https://www.lanesurf.com"}},"contextual":{"options":["copy","view","chatgpt","claude","grok","perplexity","download-spec"],"display":"header"},"markdown":{"instructions":["You are reading the Lanesurf Agent API docs. Start with /for-ai-agents.md for the rules an agent must follow.","The API is at https://agent.lanesurf.com and the MCP server at https://agent.lanesurf.com/mcp. Lanesurf doesn't send webhooks: poll.","Limits: /rate-limits.md. Keys: /api-keys.md. Safe retries: /idempotency.md. Every route on one page: /api-reference.md.","Always confirm with the person before accepting a carrier offer or bidding on a load. Never reveal an API key, and never show broker contact details to a carrier.","The full contract is at /openapi.yaml.","Sign up with POST /v1/signup (carrier or broker, a work email, an MC and/or DOT number), then POST /v1/signup/{signup_id}/verify. Follow next_step on every signup answer."]},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"lanesurf-d98c59ed","hasAudioNarration":false,"actualSubdomain":"lanesurf-d98c59ed","customDomains":["docs.lanesurf.com"],"gitSource":{"type":"github","owner":"lanesurf-org","repo":"agent-ai-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ae61b0caf08fdd71062c1a8","collectionId":"8fd05299-2b32-4bca-b0a0-35925c6f2e50","liveDeploymentHistoryId":"6ae61b0caf08fdd71062c1a8","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae61b0caf08fdd71062c1a8","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"Carriers","count":22},{"language":"default","tag":"Brokers","count":18},{"language":"default","tag":"Reference","count":14},{"language":"default","tag":"Loads API","count":12},{"language":"default","tag":"Get started","count":10},{"language":"default","tag":"Guides","count":9},{"language":"default","tag":"Trucks API","count":6},{"language":"default","tag":"Loads and bids API","count":5},{"language":"default","tag":"Sign-up API","count":3},{"language":"default","tag":"Lanes API","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".nav-logo{height:34px!important}"}],"page":{"pagePath":"api-reference/authentication/who-this-key-belongs-to","slug":"/api-reference/authentication/who-this-key-belongs-to","pageMetadata":{"title":"Who am I","description":"See who this API key belongs to.","deprecated":null,"version":null,"sidebarTitle":"Who am I","openapi":"/openapi.yaml get /v1/me","href":"/api-reference/authentication/who-this-key-belongs-to","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"See who this API key belongs to.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components};return _jsx(_components.p,{children:`Returns the principal behind the key: its role, and for carriers the verification and carrier\nrecord; for brokers the brokerage id and rep name. Works for both roles.`})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Who am I","description":"See who this API key belongs to.","deprecated":null,"version":null,"sidebarTitle":"Who am I","openapi":"/openapi.yaml get /v1/me","href":"/api-reference/authentication/who-this-key-belongs-to","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Authentication"],"summary":"Who this key belongs to","operationId":"getMe","x-mint":{"metadata":{"title":"Who am I","sidebarTitle":"Who am I","description":"See who this API key belongs to."},"content":"Returns the principal behind the key: its role, and for carriers the verification and carrier\nrecord; for brokers the brokerage id and rep name. Works for both roles.\n"},"description":"See who this API key belongs to.","responses":{"200":"20cd13df-6a86-4252-931a-97ed21429628","401":"811cf192-fcfe-4335-8058-02b4e883d48e","429":"42f3f146-1887-4a00-a936-1f7c55c92982","500":"c717319c-e838-4dea-87e2-8a171139ef9f","503":"f8c8c04a-dd00-49bf-b8b0-b14a0fd8335e"},"method":"get","type":"path","servers":["23a3a396-6c85-4043-970f-44c0c809dd8e"],"security":["6035daa8-0518-463a-af69-0d34b5a6d06e"],"path":"/v1/me","baseUrlOptions":["https://agent.lanesurf.com"],"title":"Who this key belongs to","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"20cd13df-6a86-4252-931a-97ed21429628":{"description":"The principal behind this key.","headers":{"Cache-Control":{"description":"Responses that carry secrets are never cached.","schema":{"type":"string","example":"no-store"}}},"content":{"application/json":{"schema":{"type":"object","required":["key_id","key_prefix","role"],"properties":{"key_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"key_id","typeLabel":"string\u003cuuid>"},"key_prefix":{"type":"string","example":"ls_live_1a2b","isRequired":true,"uniqueKey":"key_prefix","typeLabel":"string"},"role":{"type":"string","enum":["broker","carrier"],"isRequired":true,"uniqueKey":"role","typeLabel":"enum\u003cstring>"},"verification":{"type":"string","enum":["verified","needs_review"],"description":"Carriers only. `verified`: confirmed automatically (the signup email's domain matches an email on the\ncarrier's record; shared mailbox domains such as ISP mail never count; the authority isn't shown as\ninactive) or by Lanesurf's team.\n`needs_review`: the carrier account is under review (trucks, lanes and the bid list only).\n","uniqueKey":"verification","typeLabel":"enum\u003cstring>"},"carrier":{"type":"object","description":"Carriers only. The carrier record from the identity check, and the contact proved with the code. Empty fields are left out.","properties":{"legal_name":{"type":"string","uniqueKey":"carrier.legal_name","typeLabel":"string"},"mc_number":{"type":"string","uniqueKey":"carrier.mc_number","typeLabel":"string"},"dot_number":{"type":"string","uniqueKey":"carrier.dot_number","typeLabel":"string"},"contact_email":{"type":"string","uniqueKey":"carrier.contact_email","typeLabel":"string"},"contact_phone":{"type":"string","uniqueKey":"carrier.contact_phone","typeLabel":"string"}},"uniqueKey":"carrier","typeLabel":"object"},"broker_id":{"type":"string","format":"uuid","description":"Brokers only. The brokerage.","uniqueKey":"broker_id","typeLabel":"string\u003cuuid>"},"rep_name":{"type":"string","description":"Brokers only.","uniqueKey":"rep_name","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"key_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","key_prefix":"ls_live_1a2b","role":"broker","verification":"verified","carrier":{"legal_name":"\u003cstring>","mc_number":"\u003cstring>","dot_number":"\u003cstring>","contact_email":"\u003cstring>","contact_phone":"\u003cstring>"},"broker_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","rep_name":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"811cf192-fcfe-4335-8058-02b4e883d48e":{"description":"`missing_api_key` (no `Authorization` header) or `invalid_api_key` (wrong, malformed or revoked key).","content":{"application/json":{"schema":{"type":"object","required":["error","code"],"properties":{"error":{"type":"string","description":"A message for people.","example":"invalid API key","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"A stable machine-readable code. Branch on this, not on `error`.","enum":["missing_api_key","invalid_api_key","wrong_role","verification_required","invalid_request","missing_fields","not_found","already_covered","invalid_state","already_bid","bid_decided","idempotency_in_progress","idempotency_key_reused","idempotency_key_required","load_rejected","offer_changed","bid_update_limit","existing_customer","already_redeemed","rate_limited","invalid_code","signup_expired","broker_name_taken","broker_name_mismatch","unavailable","upstream_error","internal"],"example":"invalid_api_key","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"missing":{"type":"array","description":"`missing_fields` only: exact field names or paths still needed.","items":{"type":"string","uniqueKey":"missing.items.[INDEX]","typeLabel":"string"},"uniqueKey":"missing","typeLabel":"string[]"},"next_step":{"type":"string","description":"On signup errors and on every broker load tool's errors (`list_loads`, `post_load`, `get_load`, `load_outreach`, accept, decline, covered).","uniqueKey":"next_step","typeLabel":"string"},"current_rate":{"type":"number","description":"`offer_changed` only: the offer's rate now.","uniqueKey":"current_rate","typeLabel":"number"},"request_id":{"type":"string","description":"This request's id (also the `X-Request-Id` response header). Quote it to Lanesurf support.","example":"req_0192f3a4-7b1c-7d2e-9f00-1a2b3c4d5e6f","uniqueKey":"request_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"invalid API key","code":"invalid_api_key"},"examples":{"Example":{"title":"Example","value":{"error":"invalid API key","code":"invalid_api_key"}}},"exampleType":"examples"}},"exampleType":"examples"},"42f3f146-1887-4a00-a936-1f7c55c92982":{"description":"`rate_limited`: too many requests. Signup has limits per contact, per carrier and per IP (the 300 per 10 minutes\nlimit groups IPv6 addresses by /64). Every authenticated `/v1` route is limited to 120 requests per minute\nper API key, counted on each Lanesurf server. Wait `Retry-After`\nseconds, then retry.\n","headers":{"Retry-After":{"description":"Seconds to wait before trying again.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","required":["error","code"],"properties":{"error":{"type":"string","description":"A message for people.","example":"invalid API key","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"A stable machine-readable code. Branch on this, not on `error`.","enum":["missing_api_key","invalid_api_key","wrong_role","verification_required","invalid_request","missing_fields","not_found","already_covered","invalid_state","already_bid","bid_decided","idempotency_in_progress","idempotency_key_reused","idempotency_key_required","load_rejected","offer_changed","bid_update_limit","existing_customer","already_redeemed","rate_limited","invalid_code","signup_expired","broker_name_taken","broker_name_mismatch","unavailable","upstream_error","internal"],"example":"invalid_api_key","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"missing":{"type":"array","description":"`missing_fields` only: exact field names or paths still needed.","items":{"type":"string","uniqueKey":"missing.items.[INDEX]","typeLabel":"string"},"uniqueKey":"missing","typeLabel":"string[]"},"next_step":{"type":"string","description":"On signup errors and on every broker load tool's errors (`list_loads`, `post_load`, `get_load`, `load_outreach`, accept, decline, covered).","uniqueKey":"next_step","typeLabel":"string"},"current_rate":{"type":"number","description":"`offer_changed` only: the offer's rate now.","uniqueKey":"current_rate","typeLabel":"number"},"request_id":{"type":"string","description":"This request's id (also the `X-Request-Id` response header). Quote it to Lanesurf support.","example":"req_0192f3a4-7b1c-7d2e-9f00-1a2b3c4d5e6f","uniqueKey":"request_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"too many requests for this API key; slow down","code":"rate_limited"},"examples":{"Example":{"title":"Example","value":{"error":"too many requests for this API key; slow down","code":"rate_limited"}}},"exampleType":"examples"}},"exampleType":"examples"},"c717319c-e838-4dea-87e2-8a171139ef9f":{"description":"`internal`: unexpected error. Safe to retry later.","content":{"application/json":{"schema":{"type":"object","required":["error","code"],"properties":{"error":{"type":"string","description":"A message for people.","example":"invalid API key","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"A stable machine-readable code. Branch on this, not on `error`.","enum":["missing_api_key","invalid_api_key","wrong_role","verification_required","invalid_request","missing_fields","not_found","already_covered","invalid_state","already_bid","bid_decided","idempotency_in_progress","idempotency_key_reused","idempotency_key_required","load_rejected","offer_changed","bid_update_limit","existing_customer","already_redeemed","rate_limited","invalid_code","signup_expired","broker_name_taken","broker_name_mismatch","unavailable","upstream_error","internal"],"example":"invalid_api_key","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"missing":{"type":"array","description":"`missing_fields` only: exact field names or paths still needed.","items":{"type":"string","uniqueKey":"missing.items.[INDEX]","typeLabel":"string"},"uniqueKey":"missing","typeLabel":"string[]"},"next_step":{"type":"string","description":"On signup errors and on every broker load tool's errors (`list_loads`, `post_load`, `get_load`, `load_outreach`, accept, decline, covered).","uniqueKey":"next_step","typeLabel":"string"},"current_rate":{"type":"number","description":"`offer_changed` only: the offer's rate now.","uniqueKey":"current_rate","typeLabel":"number"},"request_id":{"type":"string","description":"This request's id (also the `X-Request-Id` response header). Quote it to Lanesurf support.","example":"req_0192f3a4-7b1c-7d2e-9f00-1a2b3c4d5e6f","uniqueKey":"request_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"invalid API key","code":"invalid_api_key","missing":["\u003cstring>"],"next_step":"\u003cstring>","current_rate":123,"request_id":"req_0192f3a4-7b1c-7d2e-9f00-1a2b3c4d5e6f"}}},"exampleType":"generated"}},"exampleType":"generated"},"f8c8c04a-dd00-49bf-b8b0-b14a0fd8335e":{"description":"`unavailable`: Lanesurf couldn't check the API key right now (the key may be fine; don't ask for a new one): wait `Retry-After` (30) seconds and send the same request again.","headers":{"Retry-After":{"description":"Seconds to wait before trying again.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","required":["error","code"],"properties":{"error":{"type":"string","description":"A message for people.","example":"invalid API key","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"A stable machine-readable code. Branch on this, not on `error`.","enum":["missing_api_key","invalid_api_key","wrong_role","verification_required","invalid_request","missing_fields","not_found","already_covered","invalid_state","already_bid","bid_decided","idempotency_in_progress","idempotency_key_reused","idempotency_key_required","load_rejected","offer_changed","bid_update_limit","existing_customer","already_redeemed","rate_limited","invalid_code","signup_expired","broker_name_taken","broker_name_mismatch","unavailable","upstream_error","internal"],"example":"invalid_api_key","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"missing":{"type":"array","description":"`missing_fields` only: exact field names or paths still needed.","items":{"type":"string","uniqueKey":"missing.items.[INDEX]","typeLabel":"string"},"uniqueKey":"missing","typeLabel":"string[]"},"next_step":{"type":"string","description":"On signup errors and on every broker load tool's errors (`list_loads`, `post_load`, `get_load`, `load_outreach`, accept, decline, covered).","uniqueKey":"next_step","typeLabel":"string"},"current_rate":{"type":"number","description":"`offer_changed` only: the offer's rate now.","uniqueKey":"current_rate","typeLabel":"number"},"request_id":{"type":"string","description":"This request's id (also the `X-Request-Id` response header). Quote it to Lanesurf support.","example":"req_0192f3a4-7b1c-7d2e-9f00-1a2b3c4d5e6f","uniqueKey":"request_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"invalid API key","code":"invalid_api_key","missing":["\u003cstring>"],"next_step":"\u003cstring>","current_rate":123,"request_id":"req_0192f3a4-7b1c-7d2e-9f00-1a2b3c4d5e6f"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"6035daa8-0518-463a-af69-0d34b5a6d06e":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"ls_live_\u003ckey>","description":"One key per broker rep or per carrier signup. Keep it secret.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"23a3a396-6c85-4043-970f-44c0c809dd8e":{"url":"https://agent.lanesurf.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"ls_live_\u003ckey>","description":"One key per broker rep or per carrier signup. Keep it secret.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"One key per broker rep or per carrier signup. Keep it secret.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"lanesurf-d98c59ed","siteName":"Lanesurf Agent API","title":"Who am I - Lanesurf Agent API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-31T16:24:09.590Z","originalFileLocation":"api-reference/authentication/who-this-key-belongs-to.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"See who this API key belongs to.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Lanesurf Agent API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/lanesurf-d98c59ed/aDfoxgMnpA3AXS2W/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/lanesurf-d98c59ed/aDfoxgMnpA3AXS2W/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lanesurf-d98c59ed/aDfoxgMnpA3AXS2W/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/lanesurf-d98c59ed/aDfoxgMnpA3AXS2W/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/lanesurf-d98c59ed/aDfoxgMnpA3AXS2W/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/lanesurf-d98c59ed/aDfoxgMnpA3AXS2W/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lanesurf-d98c59ed/aDfoxgMnpA3AXS2W/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/lanesurf-d98c59ed/aDfoxgMnpA3AXS2W/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/lanesurf-d98c59ed/aDfoxgMnpA3AXS2W/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Who am I - Lanesurf Agent API\">\u003cmeta data-mint-head property=\"og:description\" content=\"See who this API key belongs to.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Lanesurf Agent API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.lanesurf.com/api-reference/authentication/who-this-key-belongs-to\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://lanesurf-d98c59ed.mintlify.app/_mintlify/api/og/v2?division=Sign-up+and+setup+API\u0026amp;title=Who+am+I\u0026amp;description=See+who+this+API+key+belongs+to.\u0026amp;theme=0b87e052751a04850cc4f191\u0026amp;signature=5eeee417c4c1d6d84c0936faf57c9b3dd112b6e0621426f37705b496f46834ab\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Who am I - Lanesurf Agent API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"See who this API key belongs to.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lanesurf-d98c59ed.mintlify.app/_mintlify/api/og/v2?division=Sign-up+and+setup+API\u0026amp;title=Who+am+I\u0026amp;description=See+who+this+API+key+belongs+to.\u0026amp;theme=0b87e052751a04850cc4f191\u0026amp;signature=5eeee417c4c1d6d84c0936faf57c9b3dd112b6e0621426f37705b496f46834ab\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/lanesurf-d98c59ed/aDfoxgMnpA3AXS2W/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Lanesurf Agent API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2563EB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.lanesurf.com/api-reference/authentication/who-this-key-belongs-to\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/authentication/who-this-key-belongs-to.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.lanesurf.com/#organization\",\"name\":\"Lanesurf Agent API\",\"url\":\"https://docs.lanesurf.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/lanesurf-d98c59ed/XupxBXiERw20rl0s/logo/light.svg?fit=max\u0026auto=format\u0026n=XupxBXiERw20rl0s\u0026q=85\u0026s=e7e783e919601573a03ed1dcf02233f8\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.lanesurf.com#website\",\"name\":\"Lanesurf Agent API\",\"url\":\"https://docs.lanesurf.com\",\"publisher\":{\"@id\":\"https://docs.lanesurf.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.lanesurf.com/api-reference/authentication/who-this-key-belongs-to#webpage\",\"url\":\"https://docs.lanesurf.com/api-reference/authentication/who-this-key-belongs-to\",\"name\":\"Who am I\",\"description\":\"See who this API key belongs to.\",\"dateModified\":\"2026-10-31T16:24:09.590Z\",\"isPartOf\":{\"@id\":\"https://docs.lanesurf.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.lanesurf.com/api-reference/authentication/who-this-key-belongs-to#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.lanesurf.com/api-reference/authentication/who-this-key-belongs-to#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Sign-up and setup API\",\"item\":\"https://docs.lanesurf.com/api-reference/authentication/start-signup-carrier-or-broker\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Who am I\",\"item\":\"https://docs.lanesurf.com/api-reference/authentication/who-this-key-belongs-to\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.lanesurf.com/api-reference/authentication/who-this-key-belongs-to#apireference\",\"headline\":\"Who am I\",\"name\":\"Who am I\",\"description\":\"See who this API key belongs to.\",\"url\":\"https://docs.lanesurf.com/api-reference/authentication/who-this-key-belongs-to\",\"mainEntityOfPage\":{\"@id\":\"https://docs.lanesurf.com/api-reference/authentication/who-this-key-belongs-to#webpage\"},\"dateModified\":\"2026-10-31T16:24:09.590Z\",\"publisher\":{\"@id\":\"https://docs.lanesurf.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.lanesurf.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Lanesurf Agent API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Lanesurf Agent API","nav":{"global":null,"tabs":[{"tab":"Get started","icon":"rocket","pages":[{"title":"Get started","href":""}]},{"tab":"Brokers","icon":"truck-fast","groups":[{"group":"Guides","pages":[{"title":"Sign up your brokerage","icon":"key","href":"/brokers/get-a-key"},{"title":"Cover a load","icon":"truck-fast","href":"/brokers/cover-a-load"},{"title":"Load status and offers","sidebarTitle":"Status and offers","icon":"list-check","href":"/brokers/load-status"},{"title":"Manage a load","sidebarTitle":"Manage a load","icon":"pen-to-square","href":"/brokers/manage-a-load"}]},{"group":"Sign-up and setup API","pages":[{"title":"Start signup","deprecated":null,"version":null,"sidebarTitle":"Start signup","openapi":"/openapi.yaml post /v1/signup","href":"/api-reference/authentication/start-signup-carrier-or-broker"},{"title":"Verify the code","deprecated":null,"version":null,"sidebarTitle":"Verify the code","openapi":"/openapi.yaml post /v1/signup/{signup_id}/verify","href":"/api-reference/authentication/finish-signup-with-the-code"},{"title":"Get brokerage setup","deprecated":null,"version":null,"sidebarTitle":"Get setup","openapi":"/openapi.yaml get /v1/broker/setup","href":"/api-reference/broker-setup/your-brokerages-setup"},{"title":"Update brokerage setup","description":"Change company name, working hours, payment terms, CC emails, ask_first_pricing or carrier visibility.","deprecated":null,"version":null,"sidebarTitle":"Update setup","openapi":"/openapi.yaml patch /v1/broker/setup","href":"/api-reference/broker-setup/change-your-brokerages-setup"},{"title":"Who am I","deprecated":null,"version":null,"sidebarTitle":"Who am I","openapi":"/openapi.yaml get /v1/me","href":"/api-reference/authentication/who-this-key-belongs-to"}]},{"group":"Loads API","pages":[{"title":"List your loads","description":"The loads your brokerage posted through the API, newest first, a page at a time.","deprecated":null,"version":null,"sidebarTitle":"List your loads","openapi":"/openapi.yaml get /v1/loads","href":"/api-reference/broker-loads/list-your-loads"},{"title":"Post a load","deprecated":null,"version":null,"sidebarTitle":"Post a load","openapi":"/openapi.yaml post /v1/loads","href":"/api-reference/broker-loads/post-a-load"},{"title":"Get load status","deprecated":null,"version":null,"sidebarTitle":"Get load status","openapi":"/openapi.yaml get /v1/loads/{id}","href":"/api-reference/broker-loads/load-status-and-carrier-offers"},{"title":"Edit a load","deprecated":null,"version":null,"sidebarTitle":"Edit load","openapi":"/openapi.yaml patch /v1/loads/{id}","href":"/api-reference/broker-loads/edit-a-load"},{"title":"Delete a load","deprecated":null,"version":null,"sidebarTitle":"Delete load","openapi":"/openapi.yaml delete /v1/loads/{id}","href":"/api-reference/broker-loads/delete-a-load"},{"title":"Load outreach","deprecated":null,"version":null,"sidebarTitle":"Load outreach","openapi":"/openapi.yaml get /v1/loads/{id}/outreach","href":"/api-reference/broker-loads/who-was-contacted-on-a-load"},{"title":"Accept an offer","deprecated":null,"version":null,"sidebarTitle":"Accept an offer","openapi":"/openapi.yaml post /v1/loads/{id}/offers/{session_id}/accept","href":"/api-reference/broker-loads/accept-a-carriers-offer"},{"title":"Decline an offer","deprecated":null,"version":null,"sidebarTitle":"Decline an offer","openapi":"/openapi.yaml post /v1/loads/{id}/offers/{session_id}/decline","href":"/api-reference/broker-loads/decline-a-carriers-offer"},{"title":"Mark covered","deprecated":null,"version":null,"sidebarTitle":"Mark covered","openapi":"/openapi.yaml post /v1/loads/{id}/covered","href":"/api-reference/broker-loads/mark-the-load-covered-elsewhere"},{"title":"Pause a load","deprecated":null,"version":null,"sidebarTitle":"Pause load","openapi":"/openapi.yaml post /v1/loads/{id}/pause","href":"/api-reference/broker-loads/pause-a-load"},{"title":"Resume a load","deprecated":null,"version":null,"sidebarTitle":"Resume load","openapi":"/openapi.yaml post /v1/loads/{id}/resume","href":"/api-reference/broker-loads/resume-a-load"},{"title":"Reopen a covered load","deprecated":null,"version":null,"sidebarTitle":"Reopen load","openapi":"/openapi.yaml post /v1/loads/{id}/reopen","href":"/api-reference/broker-loads/reopen-a-covered-load"}]}]},{"tab":"Carriers","icon":"truck","groups":[{"group":"Guides","pages":[{"title":"Sign up","icon":"user-plus","href":"/carriers/sign-up"},{"title":"Get your truck loaded","sidebarTitle":"Get loaded","icon":"magnifying-glass-location","href":"/carriers/find-a-load"},{"title":"Post a truck","sidebarTitle":"Posting trucks","icon":"truck","href":"/carriers/post-a-truck"},{"title":"Save your lanes","sidebarTitle":"Lanes","icon":"route","href":"/carriers/lanes"},{"title":"Bid on a load","sidebarTitle":"Bidding","icon":"hand","href":"/carriers/bid-on-a-load"}]},{"group":"Sign-up API","pages":[{"title":"Start signup","deprecated":null,"version":null,"sidebarTitle":"Start signup","openapi":"/openapi.yaml post /v1/signup","href":"/api-reference/authentication/start-signup-carrier-or-broker"},{"title":"Verify the code","description":"Send the 8-digit code (brokers also say who they are). Get your API key.","deprecated":null,"version":null,"sidebarTitle":"Verify the code","openapi":"/openapi.yaml post /v1/signup/{signup_id}/verify","href":"/api-reference/authentication/finish-signup-with-the-code"},{"title":"Who am I","deprecated":null,"version":null,"sidebarTitle":"Who am I","openapi":"/openapi.yaml get /v1/me","href":"/api-reference/authentication/who-this-key-belongs-to"}]},{"group":"Trucks API","pages":[{"title":"Post a truck","description":"Say where a truck is, when it's free, and where it wants to go.","deprecated":null,"version":null,"sidebarTitle":"Post a truck","openapi":"/openapi.yaml post /v1/carrier/trucks","href":"/api-reference/carrier-trucks/post-an-available-truck"},{"title":"List my trucks","deprecated":null,"version":null,"sidebarTitle":"List my trucks","openapi":"/openapi.yaml get /v1/carrier/trucks","href":"/api-reference/carrier-trucks/list-my-trucks"},{"title":"Get a truck","deprecated":null,"version":null,"sidebarTitle":"Get a truck","openapi":"/openapi.yaml get /v1/carrier/trucks/{truck_id}","href":"/api-reference/carrier-trucks/get-a-truck"},{"title":"Update a truck","deprecated":null,"version":null,"sidebarTitle":"Update a truck","openapi":"/openapi.yaml patch /v1/carrier/trucks/{truck_id}","href":"/api-reference/carrier-trucks/update-a-truck"},{"title":"Remove a truck","deprecated":null,"version":null,"sidebarTitle":"Remove a truck","openapi":"/openapi.yaml delete /v1/carrier/trucks/{truck_id}","href":"/api-reference/carrier-trucks/remove-a-truck"},{"title":"Loads for a truck","deprecated":null,"version":null,"sidebarTitle":"Loads for a truck","openapi":"/openapi.yaml get /v1/carrier/trucks/{truck_id}/matches","href":"/api-reference/carrier-loads/loads-that-fit-this-truck"}]},{"group":"Lanes API","pages":[{"title":"Save a lane","deprecated":null,"version":null,"sidebarTitle":"Save a lane","openapi":"/openapi.yaml post /v1/carrier/lanes","href":"/api-reference/carrier-lanes/save-a-lane"},{"title":"List my lanes","deprecated":null,"version":null,"sidebarTitle":"List my lanes","openapi":"/openapi.yaml get /v1/carrier/lanes","href":"/api-reference/carrier-lanes/list-my-lanes"},{"title":"Remove a lane","deprecated":null,"version":null,"sidebarTitle":"Remove a lane","openapi":"/openapi.yaml delete /v1/carrier/lanes/{lane_id}","href":"/api-reference/carrier-lanes/remove-a-lane"}]},{"group":"Loads and bids API","pages":[{"title":"Search loads","deprecated":null,"version":null,"sidebarTitle":"Search loads","openapi":"/openapi.yaml get /v1/carrier/loads/search","href":"/api-reference/carrier-loads/search-loads-near-a-zip-or-city-or-by-state"},{"title":"Get a load","deprecated":null,"version":null,"sidebarTitle":"Get a load","openapi":"/openapi.yaml get /v1/carrier/loads/{load_id}","href":"/api-reference/carrier-loads/one-loads-details"},{"title":"Bid on a load","deprecated":null,"version":null,"sidebarTitle":"Bid on a load","openapi":"/openapi.yaml post /v1/carrier/loads/{load_id}/bids","href":"/api-reference/carrier-loads/bid-on-a-load"},{"title":"My bids","deprecated":null,"version":null,"sidebarTitle":"My bids","openapi":"/openapi.yaml get /v1/carrier/bids","href":"/api-reference/carrier-loads/my-bids-and-their-status"},{"title":"My outreach","deprecated":null,"version":null,"sidebarTitle":"My outreach","openapi":"/openapi.yaml get /v1/carrier/outreach","href":"/api-reference/carrier-loads/lanesurf-outreach-i-received"}]}]},{"tab":"Reference","icon":"book","pages":[{"title":"Reference","href":"/api-reference"}]}]},"basePath":"","title":"Who am I - Lanesurf Agent API","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}