Get Qualification Session Details

Get the status of a qualification_session based on the qualification_session_id.

Request Notes

To get the status of a Qualification Session object, call the detail view with the ID of the qualification session returned by the Qualification Session Completed webhook.

Response Notes

status - the status of the qualification session, an enum with one of the following values:
- pending - the User has not yet completed the survey
- processing - the user has completed the session and it is under review
- approved - the user has been issued a Letter-of-Medical-Necessity for the items specified in the create_qualification_session API call’s order_items field.
- rejected - the user is ineligible to receive a Letter-of-Medical-Necessity for the items specified in the create_qualification_session API call’s order_items field.

Get the status of a `qualification_session` based on the `qualification_session_id`. ## Request Notes To get the status of a Qualification Session object, call the detail view with the ID of the qualification session returned by the [Qualification Session Completed](/api-reference/qualification-sessions/qualification-status-updated-webhook) webhook. ## Response Notes - `status` - the status of the qualification session, an enum with one of the following values: - `pending` - the User has not yet completed the survey - `processing` - the user has completed the session and it is under review - `approved` - the user has been issued a Letter-of-Medical-Necessity for the items specified in the `create_qualification_session` API call's `order_items` field. - `rejected` - the user is ineligible to receive a Letter-of-Medical-Necessity for the items specified in the `create_qualification_session` API call's `order_items` field.

Authentication

x-truemed-api-keystring

Sales channel API key for merchant server-to-server authentication

Path parameters

qualification_session_idstringRequired

The qualification session ID from the URL path

Response

Successful response

qualification_session_idstring

The id of the payment session.

statusenum

The status of the initial payment.

Allowed values:

expires_atdatetime or null

The datetime at which the Letter-of-Medical-Necessity expires.

sourcestring or null

The source provided in the qualification session redirect URL param.

user_idstring or null

The user_id provided in the qualification session redirect URL param.

Errors

Get the status of a qualification_session based on the qualification_session_id.

Request Notes

To get the status of a Qualification Session object, call the detail view with the ID of the qualification session returned by the Qualification Session Completed webhook.

Response Notes

status - the status of the qualification session, an enum with one of the following values:
- pending - the User has not yet completed the survey
- processing - the user has completed the session and it is under review
- approved - the user has been issued a Letter-of-Medical-Necessity for the items specified in the create_qualification_session API call’s order_items field.
- rejected - the user is ineligible to receive a Letter-of-Medical-Necessity for the items specified in the create_qualification_session API call’s order_items field.

1	import requests
2
3	url = "https://dev-api.truemed.com/api/v1/qualification_session/qualification_session_id"
4
5	headers = {"x-truemed-api-key": "<apiKey>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"qualification_session_id": "qs_9f8b7c6d5e4a3b2c1d0e",
3	"status": "processing",
4	"expires_at": "2024-12-31T23:59:59Z",
5	"source": "email_campaign_2024_q1",
6	"user_id": "user_1234567890abcdef"
7	}