Returns information about the user’s completed session to be processed by the partner. You'll need to create a webhook to receive these requests.

SUMMARY

This request occurs when terminal status updates for a user's session happen inside of the service. The status returned could be one of two types:

  • approved: The prescription is approved and dispensed. Will contain a dispensed_prescription object with Rx details.
  • referred: Prescriptions were unable to be dispensed.

An array of assets will be included for each dispensed prescription for an approval event. The asset source value is a Base64 encoded string of bytes for a file of the indicated content type. While the sample includes a dispensed prescription for both contact lenses and glasses, the actual response will include the types of prescriptions requested in the Order object when Creating a Session.

📘

Acuity Screening

Users who have an order for the Acuity Screener will reach terminal status after their medical profile has been completed. In this case, there will be no status in the POST and a data object containing visual acuity results, correction worn, and eye health information will be returned.

JSON

{
  "user_key": "user1",
  "session_key": "session1",
  "type": "session_completed",
  "status": "approved",
  "created_at": "2017-03-16T19:29:56Z",
  "dispensed_prescriptions": [
    {
      "id": 1234,
      "type": "contacts",
      "issue_date": "2017-03-16",
      "expiration_date": "2018-03-16",
      "right_eye": {
        "product_keys": [
          "example1"
        ],
        "brand_label": "Example Brand",
        "model_label": "Example Model",
        "sphere": -1.0,
        "cylinder": -0.25,
        "axis": 90,
        "add": null,
        "base_curve": 8.7,
        "diameter": 14.1,
        "dominance": null
      },
      "left_eye": {
        "product_keys": [
          "example1"
        ],
        "brand_label": "Example Brand",
        "model_label": "Example Model",
        "sphere": -1.0,
        "cylinder": -0.25,
        "axis": 90,
        "add": null,
        "base_curve": 8.7,
        "diameter": 14.1,
        "dominance": null
      },
      "provider": {
        "first_name": "Example",
        "last_name": "Provider",
        "license_identifier": "12345",
        "practice": {
          "name": "Example Practice",
          "phone": "+15555555555",
          "street1": "123 Fake St",
          "street2": "Suite 42",
          "city": "Chicago",
          "region": "IL",
          "postal": "60607",
          "country": "US"
        }
      },
      "assets": [
        {
          "type": "prescription",
          "content_type": "application/pdf",
          "source": "aW91YXNoZGZsa2Fza..."
        }
      ],
      "brand_renewal": true
    },
    {
      "id": 5678,
      "type": "glasses",
      "issue_date": "2017-03-16",
      "expiration_date": "2018-03-16",
      "right_eye": {
        "sphere": -1.0,
        "cylinder": -0.25,
        "axis": 90,
        "add": null,
        "dominance": null,
        "pupillary_distance": 30.0
      },
      "left_eye": {
        "sphere": -1.0,
        "cylinder": -0.25,
        "axis": 90,
        "add": null,
        "dominance": null,
        "pupillary_distance": 30.0
      },
      "provider": {
        "first_name": "Example",
        "last_name": "Provider",
        "license_identifier": "12345",
        "practice": {
          "name": "Example Practice",
          "phone": "+15555555555",
          "street1": "123 Fake St",
          "street2": "Suite 42",
          "city": "Chicago",
          "region": "IL",
          "postal": "60607",
          "country": "US"
        }
      },
      "assets": [
        {
          "type": "prescription",
          "content_type": "application/pdf",
          "source": "aW91YXNoZGZsa2Fza..."
        }
      ]
    }
  ]
}
Language
Authentication
Click Try It! to start a request and see the response here!