Get consultation result

Retrieves the clinical result produced during a SOFT Integration consultation, identified by the requestId you generated when requesting the signature.

Use this endpoint after being notified that the result is ready, either through the WebSocket or through the webhook.

Request description

Endpoint: /api/v1/soft-integration/{requestId}/result
Method: GET

Path parameters

Header

{
  "Authorization": "Bearer <accessToken>"
}

The access token is the same one used to generate the signature. Access is scoped to the organization that owns the consultation: a token from a different organization is rejected.

To set the API version on a specific request, you can add a specific header named X-Invox-Medical-Api-Version with the value of the version you are targeting:

X-Invox-Medical-Api-Version: 2026-08-01

2026-08-01 is the only version this endpoint accepts. Omitting the header resolves to the latest version.

Result availability

The result is kept in temporary storage for 24 hours after the consultation finishes. Once that period elapses the result is removed and the endpoint responds 410.

Responses

Correct response

{
  "result": {
    // identical payload to the onReportFinished webhook event
  }
}

Wrong responses

{
  // empty body
}

Description: no valid credential was supplied.

{
  "message": "The requested consultation belongs to another organization.",
  "errorType": "invalidPermission"
}

Description: the requestId exists but belongs to a different organization.

{
  "message": "No consultation found for the provided requestId.",
  "errorType": "requestNotFound"
}

{
  "message": "The consultation has not finished yet.",
  "errorType": "resultNotReady"
}

Description: the consultation exists but has not produced a result yet. Wait for the notification instead of polling aggressively.

{
  "message": "The result is no longer available.",
  "errorType": "resultExpired"
}

Description: the result was produced but has already been removed from temporary storage. It cannot be recovered; the consultation would have to be repeated.

Example

const response = await fetch(
  `https://api-suite.invoxmedical.com/api/v1/soft-integration/${requestId}/result`,
  { headers: { Authorization: `Bearer ${accessToken}` } },
);

switch (response.status) {
  case 200: {
    const { result } = await response.json();
    // persist the result in your EHR
    break;
  }
  case 409:
    // not finished yet — wait for the notification
    break;
  case 410:
    // expired — no longer recoverable
    break;
  default:
  // 401 / 403 / 404 — check credentials and requestId
}

using System.Net;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", accessToken);

var response = await client.GetAsync(
    $"https://api-suite.invoxmedical.com/api/v1/soft-integration/{requestId}/result");

switch (response.StatusCode)
{
    case HttpStatusCode.OK:
        using (var doc = JsonDocument.Parse(await response.Content.ReadAsStringAsync()))
        {
            var result = doc.RootElement.GetProperty("result");
            // persist the result in your EHR
        }
        break;
    case HttpStatusCode.Conflict:
        // not finished yet — wait for the notification
        break;
    case HttpStatusCode.Gone:
        // expired — no longer recoverable
        break;
    default:
        // 401 / 403 / 404 — check credentials and requestId
        break;
}

import java.net.URI;
import java.net.http.*;
import com.fasterxml.jackson.databind.*;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api-suite.invoxmedical.com/api/v1/soft-integration/"
        + requestId + "/result"))
    .header("Authorization", "Bearer " + accessToken)
    .GET()
    .build();

HttpResponse<String> response = client.send(
    request, HttpResponse.BodyHandlers.ofString());

switch (response.statusCode()) {
    case 200 -> {
        JsonNode result = new ObjectMapper().readTree(response.body()).get("result");
        // persist the result in your EHR
    }
    case 409 -> { /* not finished yet — wait for the notification */ }
    case 410 -> { /* expired — no longer recoverable */ }
    default -> { /* 401 / 403 / 404 — check credentials and requestId */ }
}

import requests

response = requests.get(
    f"https://api-suite.invoxmedical.com/api/v1/soft-integration/{request_id}/result",
    headers={"Authorization": f"Bearer {access_token}"},
)

if response.status_code == 200:
    result = response.json()["result"]
    # persist the result in your EHR
elif response.status_code == 409:
    pass  # not finished yet — wait for the notification
elif response.status_code == 410:
    pass  # expired — no longer recoverable
else:
    pass  # 401 / 403 / 404 — check credentials and requestId