Close Session

curl --request DELETE \
  --url https://api-sandbox.letshum.com/sessions/{token} \
  --header 'Authorization: Bearer <token>'

{
  "message": "Session closed successfully",
  "request_status": "ok",
  "data": {},
  "meta": {
    "session_token": "XqCmeTVgYXrbWrZFZEymkD",
    "session_status": "open",
    "responded_at": "2024-09-20T23:13:31.179Z",
    "hum_data_set": "25041808",
    "agent_status": {
      "geocoding": "matched",
      "internet": "matched",
      "checkout": "pending"
    },
    "session_params": {
      "street1": "29090 Tiffany Drive E",
      "state": "MI",
      "zip": 48034,
      "street2": "A2",
      "city": "Southfield",
      "latitude": 42.501721339274,
      "longitude": -83.286263465881,
      "campaign_id": "1iYyMxsnTy87tFOvukTi7V"
    },
    "service_address": "1420 Washington Blvd, Detroit, MI 48201",
    "created_at": "2024-09-20T23:13:31.179Z",
    "updated_at": "2024-09-20T23:13:31.179Z"
  }
}

Sessions

Close Session

Explicitly closes an active session. While sessions automatically expire after inactivity, it’s best practice to close them when you’re done to free up resources.

Closing Behavior

All agent processing stops immediately
Cached results are cleared
Session token becomes invalid
Resources are freed

When to Close

After completing service lookup
When switching to a different address
After receiving final results
When abandoning a search

Important Notes

Cannot be undone
New session required for same address
Final results should be saved before closing
Rate limits still apply

DELETE

sessions

{token}

Close Session

curl --request DELETE \
  --url https://api-sandbox.letshum.com/sessions/{token} \
  --header 'Authorization: Bearer <token>'

{
  "message": "Session closed successfully",
  "request_status": "ok",
  "data": {},
  "meta": {
    "session_token": "XqCmeTVgYXrbWrZFZEymkD",
    "session_status": "open",
    "responded_at": "2024-09-20T23:13:31.179Z",
    "hum_data_set": "25041808",
    "agent_status": {
      "geocoding": "matched",
      "internet": "matched",
      "checkout": "pending"
    },
    "session_params": {
      "street1": "29090 Tiffany Drive E",
      "state": "MI",
      "zip": 48034,
      "street2": "A2",
      "city": "Southfield",
      "latitude": 42.501721339274,
      "longitude": -83.286263465881,
      "campaign_id": "1iYyMxsnTy87tFOvukTi7V"
    },
    "service_address": "1420 Washington Blvd, Detroit, MI 48201",
    "created_at": "2024-09-20T23:13:31.179Z",
    "updated_at": "2024-09-20T23:13:31.179Z"
  }
}

Authorizations

Authorization

string

header

required

Bearer token authentication using JWT tokens. Include the token in the Authorization header as: Authorization: Bearer <token>

Obtain tokens through your Hum API account dashboard or contact [email protected] for access.

Path Parameters

token

string

required

The session token identifying the specific session The session token provided by the Hum API. Used to connect the response to the session in the client system.

Example:

"XqCmeTVgYXrbWrZFZEymkD"

Response

Session closed successfully

message

string

required

Example:

"Session closed successfully"

request_status

enum<string>

required

A status code summarizing the outcome of this response.

ok: Request was successful
warning: Request was processed but with some issues
error: Request failed

Available options:

ok,

warning,

error

Example:

"ok"

data

object

required

Empty object for this response

meta

object

required

Metadata about the session. Can be used to track the status of the session, time since creation, and time since last update.

Show child attributes

meta.session_token

string

required

The session token provided by the Hum API. Used to connect the response to the session in the client system.

Example:

"XqCmeTVgYXrbWrZFZEymkD"

meta.session_status

enum<string> | null

required

The status of the session.

Available options:

open,

closed

Example:

"open"

meta.responded_at

string<date-time>

required

The timestamp when the response was generated.

Example:

"2024-09-20T23:13:31.179Z"

meta.hum_data_set

string

required

The version of the Hum data set used to generate the response. This version may change as the data set is updated.

Example:

"25041808"

meta.agent_status

object

Show child attributes

meta.agent_status.geocoding

enum<string>

The status of the geocoding agent. Pending: The agent has not yet processed the address. Matched: The agent has found a single match for the address. Multiple: The agent has found multiple matches for the address. Failed: The agent was unable to match the address.

Available options:

pending,

matched,

multiple,

failed

Example:

"matched"

meta.agent_status.internet

enum<string>

The status of the Internet service availability agent. Pending: The agent has not yet processed the address. Matched: The agent has found Internet service providers for the address. Failed: The agent was unable to find Internet service providers for the address.

Available options:

pending,

matched,

failed

Example:

"matched"

meta.agent_status.checkout

enum<string>

The status of the checkout agent. Pending: The agent has not yet begun processing a checkout for service.

Available options:

pending

Example:

"pending"

meta.session_params

object

Show child attributes

meta.session_params.street1

string

required

The street address of the service location.

Required string length: 1 - 100

Example:

"29090 Tiffany Drive E"

meta.session_params.state

enum<string>

required

The two-letter state abbreviation of the service location.

Available options:

AL,

AK,

AZ,

AR,

CA,

CO,

CT,

DE,

FL,

GA,

HI,

ID,

IL,

IN,

IA,

KS,

KY,

LA,

ME,

MD,

MA,

MI,

MN,

MS,

MO,

MT,

NE,

NV,

NH,

NJ,

NM,

NY,

NC,

ND,

OH,

OK,

OR,

PA,

PR,

RI,

SC,

SD,

TN,

TX,

UT,

VT,

VA,

WA,

WV,

WI,

WY

Example:

"MI"

meta.session_params.zip

string

required

The ZIP code of the service location in 12345 or 12345-6789 format.

Example:

48034

meta.session_params.street2

string

The unit, apartment, or suite number of the service location.

Required string length: 1 - 50

Example:

"A2"

meta.session_params.city

string

The city of the service location.

Required string length: 1 - 50

Example:

"Southfield"

meta.session_params.latitude

number<float>

The latitude of the service address.

Example:

42.501721339274

meta.session_params.longitude

number<float>

The longitude of the service address.

Example:

-83.286263465881

meta.session_params.campaign_id

string

A unique identifier for the campaign. This is used to track the source of the session in your internal system.

Required string length: 1 - 100

Example:

"1iYyMxsnTy87tFOvukTi7V"

meta.service_address

string | null

The complete service address as a single string.

Example:

"1420 Washington Blvd, Detroit, MI 48201"

meta.created_at

string<date-time> | null

The timestamp when the session was created.

Example:

"2024-09-20T23:13:31.179Z"

meta.updated_at

string<date-time> | null

The timestamp when the session was last updated.

Example:

"2024-09-20T23:13:31.179Z"

Get Session Status Get Internet Service Availability

⌘I

Sessions

Service Availability

Health Check

Informational

Close Session

Closing Behavior

When to Close

Important Notes

Authorizations

Path Parameters

Response