---
title: "Get ID Summary"
url: "https://developer.incode.com/api-reference/get-id-summary/"
section: "api-reference"
group: "Id capture"
version: "v1.1"
status: "live"
endpoint: "GET /omni/get/id-summary"
---
# Get ID Summary

`GET /omni/get/id-summary`

Base URL: `https://demo-api.incodesmile.com` — Incode demo environment

Returns success information about addFront and addBack. Also returns onlyFront flag.

## Path & query parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | query | string |  | Id of onboarding for which data are requested. If not present, it will be extracted from token. |
| `api-version` | header | string | yes |  |

## Responses

### 200

OK

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `onlyFront` | boolean |  |  |
| `addFrontResult` | IdSummaryDocumentSideResult |  |  |
| `addFrontResult.classification` | boolean |  |  |
| `addFrontResult.readability` | boolean |  |  |
| `addFrontResult.sharpness` | integer (int32) |  |  |
| `addFrontResult.glare` | integer (int32) |  |  |
| `addBackResult` | IdSummaryDocumentSideResult |  |  |
| `addBackResult.classification` | boolean |  |  |
| `addBackResult.readability` | boolean |  |  |
| `addBackResult.sharpness` | integer (int32) |  |  |
| `addBackResult.glare` | integer (int32) |  |  |

### 400

Bad Request

Response body (`application/json`):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timestamp` | integer (int64) |  | UTC timestamp in milliseconds |
| `status` | integer (int32) |  | Custom error code or HTTP status code |
| `error` | string |  | HTTP status error |
| `message` | string |  | Custom error message |
| `path` | string |  | Endpoint path |
| `details` | object |  | Custom error details |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X GET https://demo-api.incodesmile.com/omni/get/id-summary \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "api-version: 1.0"
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/omni/get/id-summary", {
  method: "GET",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "api-version": "1.0",
  },
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "api-version": "1.0",
}
res = requests.get("https://demo-api.incodesmile.com/omni/get/id-summary", headers=headers)
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/omni/get/id-summary"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("api-version", "1.0")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Example response

```json
{
  "success": true,
  "status": "OK"
}
```