# Compare faces in two image URLs

Operation ID: `patient.visionFaceCompare`

Download two HTTPS image URLs and compare faces via AWS Rekognition CompareFaces, returning whether both depict the same person. Requires a Bearer JWT (any authenticated pool type).

## Public method

`compareFacesByUrl`

Signature: `patient.compareFacesByUrl(request)`

Return type: `Promise<FaceCompareResponse>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`POST /vision/face-compare`

## Path parameters

None.

## Query parameters

None.

## Body parameters

| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|---|---|---:|---|---|---|---:|---|
| `body` | [`VisionFaceCompareRequest`](../models/VisionFaceCompareRequest.md) | No |  |  |  | No |  |

Request model: [`VisionFaceCompareRequest`](../models/VisionFaceCompareRequest.md)

## Request example

```json
{
  "image_url_1": "https://example.com/images/face-1.jpg",
  "image_url_2": "https://example.com/images/face-2.jpg",
  "similarity_threshold": 80
}
```

## Success responses

| Status | Shape | Content type | Description |
|---|---|---|---|
| `200` | [`VisionFaceCompareResponse`](../models/VisionFaceCompareResponse.md) | application/json | Face comparison result |

## Success response examples

### 200

```json
{
  "confidence": 100,
  "face_detected_in_image_1": true,
  "face_detected_in_image_2": true,
  "same_person": true,
  "similarity_threshold": 80
}
```

## Common errors

| Status | Shape | Content type | Description |
|---|---|---|---|
| `400` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | image_url_1/image_url_2 are missing or not valid HTTP(S) URLs |
| `401` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
| `500` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Internal server error |

## Error examples

### 400 — An image URL is not a valid HTTP/HTTPS URL

```json
{
  "error": "image_url_1 must be a valid HTTP/HTTPS URL"
}
```

### 400 — Required image URLs are missing

```json
{
  "error": "image_url_1 and image_url_2 are required"
}
```

### 401 — Missing or invalid access token

```json
{
  "error": "Authorization required"
}
```

### 500 — Unexpected service failure (sanitized example)

```json
{
  "error": "Internal server error"
}
```

## NodeJS / TypeScript implementation

```ts
import { HCSDK } from "@healthcloudai/hc-sdk";
import type { FaceCompareRequest } from "@healthcloudai/hc-sdk";
```

```ts
const request = {
  "image_url_1": "https://example.com/images/face-1.jpg",
  "image_url_2": "https://example.com/images/face-2.jpg",
  "similarity_threshold": 80
};

const result = await patient.compareFacesByUrl(request);
```

## cURL

```bash
curl -X POST \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"image_url_1":"https://example.com/images/face-1.jpg","image_url_2":"https://example.com/images/face-2.jpg","similarity_threshold":80}' \
  'https://dev-api-patient.health.cloud/vision/face-compare'
```

## Notes

None.

## Prepared Test Console scenario

No canonical scenario is currently associated.

## Real response

No approved real integration response is currently published. Unapproved candidates are never rendered as examples.