Verify Instant Messaging Access Token

Description

Endpoint used to verify the validity of an instant messaging access token for a specific practitioner user.

HTTP Definition

Method: GET
Endpoint URL: /api/v1/messages/instant/access/token

Headers

The following HTTP headers are required with this request:

Name	Data Type	Notes
ApiKey	string	The unique key issued by Quicksilva to identify your system.
Content-Type	string	Must define the request content as 'application/json'.
Conneqt-Instant-Access-Token	string	The token used to verify the authorization of a user to perform instant messaging.

GET https://int.conneqt.health/api/v1/messages/instant/access/token/verify HTTP/1.1
Content-Type: application/json; charset=utf-8
ApiKey: <API-KEY-PLACEHOLDER>
Conneqt-Instant-Access-Token: <Access-token-placeholder>

URL Parameters

The request contains no URL parameters.

Request JSON Definition

This message does not include a request payload.

Response Definition

HTTP/1.1 200 OK

HTTP/1.1 410 GONE

Error Responses

If there was an issue processing your request, a HTTP error response will be returned, containing details of the issue. Common problems include:

One or more invalid data items were found in the request.
The intended recipient organisation is not one that uses our system.

The system uses the definition of an IETF Problem, as described in RFC 7807, in error responses to provide machine-readable details of why a request was rejected. The content of the Problem returned depends on the nature of the issue.

HTTP Response Code	HTTP Reason Code	Description
400	Bad Request	Validation issues found in your request.
401	Unauthorized	Missing or Invalid API Key in the Request Header.
403	Forbidden	Unauthorized Client System - The Provided API Key Is Valid but Not Authorized.
500	Internal Server Error	Internal Server Error - An Internal Server Error Prevented the Request from Being Processed.

HTTP/1.1 400 Bad Request
Content-Type: application/problem+json

{
  "type": "https//qxlva.com/im1toolbar/documentation/api/v1/validation-error",
  "title": "Request Validation Error",
  "status": 400,
  "instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000",
  "invalidParameters": [
    {
      "name": "AccessToken",
      "reason": "Access token must be provided"
    }
  ]
}