qualificationSessions

Retrieve details and eligibility result of a qualification session

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.

get/api/v1/qualification_session/{qualification_session_id}

Request

  • Base URL: https://dev-api.truemed.com
  • URL: https://dev-api.truemed.com/api/v1/qualification_session/{qualification_session_id}
  • Auth: API key in header x-truemed-api-key

Path parameters

qualification_session_idstring required

The qualification session ID from the URL path

Response

Successful response

charge_group_created_atstring date-time nullable

When the charge group was created.

created_atstring date-time nullable

When the qualification session was created.

customer_statusstring nullable

The customer's status.

eligible_amountnumber double nullable

The eligible amount for this qualification.

emailstring nullable

The email address of the consumer who completed the qualification session.

expires_atstring date-time nullable

The datetime at which the Letter-of-Medical-Necessity expires (inclusive, UTC).

feenumber double nullable

The fee amount for this qualification.

lmn_reviewed_atstring date-time nullable

When the Letter of Medical Necessity was reviewed.

qualification_session_idstring required

The id of the qualification session.

session_typestring nullable

The type of qualification session.

skus_paramstring nullable

The SKUs parameter from the qualification session.

sourcestring nullable

The source provided in the qualification session redirect URL param.

status'pending' | 'processing' | 'approved' | 'rejected' required

Qualification status summary for the v1 qualification-session surface.

Its wire values are the long-standing v1 contract (pending/processing/approved/rejected); the v2 Truemed Session surface uses TruemedSessionQualificationStatus with its own vocabulary, so the two evolve independently and v1 clients keep the values they already depend on.

It abstracts the internal nuances of the qualification session and LMN verification status. It is to be used by merchants external to Truemed.

stripe_invoice_idstring nullable

The Stripe invoice ID associated with this qualification.

stripe_invoice_numberstring nullable

The Stripe invoice number.

stripe_invoice_paid_atstring date-time nullable

When the Stripe invoice was paid.

user_business_idstring nullable

The user's business ID.

user_idstring nullable

The user_id provided in the qualification session redirect URL param.

user_namestring nullable

The user's name (may be null if PII is hidden).

Changes

No recorded changes to this operation across all 1 revision of this API.