> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.withverifa.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.withverifa.com/_mcp/server.

# Update match status

PATCH https://api.withverifa.com/api/v1/consortiums/{consortium_id}/matches/{match_id}
Content-Type: application/json

Update the investigation status of a consortium match. Terminal statuses
(`confirmed_fraud`, `false_positive`, `resolved`) trigger a
`consortium.investigation_updated` webhook to both organizations
involved. The peer's payload is gated by the acting organization's
sharing policy.

Setting status to `confirmed_fraud` automatically triggers fraud ring
detection via BFS traversal of connected sessions.


Reference: https://docs.withverifa.com/api-reference/consortiums/update-consortium-match

## Authentication

- `X-API-Key` header (required) — Organization API key. Keys are prefixed with `vk_live_` (production) or `vk_sandbox_` (sandbox).

## Request

### Path parameters

- `consortium_id` (string, required)
- `match_id` (string, required)

### Headers

- `Verifa-Version` (date, optional) — API version date string (e.g. `2026-02-01`). If omitted, the version pinned to your API key is used.
- `Key-Inflection` (enum, optional, default: snake) — Response key casing. Defaults to `snake`.
  - Allowed values: `camel`, `kebab`, `snake`

### Body (application/json)

This endpoint expects an object.

- `status` (enum, required)
  - Allowed values: `new`, `under_investigation`, `confirmed_fraud`, `false_positive`, `resolved`
- `resolution_notes` (string, optional, nullable) — Optional notes about the investigation outcome.

## Response

### 200

Updated match.

- `id` (string, required)
- `consortium_id` (string, required)
- `match_type` (enum, required)
  - Allowed values: `face`, `document`, `face_and_document`
- `status` (enum, required)
  - Allowed values: `new`, `under_investigation`, `confirmed_fraud`, `false_positive`, `resolved`
- `created_at` (datetime, required)
- `face_similarity_score` (double, optional, nullable) — Cosine similarity between face embeddings (0–1).
- `name_mismatch` (boolean, optional) — True if the names on the two sessions differ.
- `dob_mismatch` (boolean, optional) — True if the dates of birth differ.
- `document_type_mismatch` (boolean, optional)
- `document_number_match` (boolean, optional) — True if the same document number appears at both orgs.
- `email_match` (boolean, optional)
- `phone_match` (boolean, optional)
- `device_match` (boolean, optional)
- `days_between` (integer, optional, nullable) — Days between the two sessions' creation dates.
- `ghost_student_score` (integer, optional, nullable) — Composite fraud risk score (0–100).
- `ghost_student_tier` (enum, optional) — Risk tier derived from ghost_student_score.
  - Allowed values: `pass`, `monitor`, `review`, `hold`
- `primary_session_id` (string, optional, nullable) — Present when sharing_level is "match_details" or higher.
- `primary_org_id` (string, optional, nullable)
- `matched_session_id` (string, optional, nullable)
- `matched_org_id` (string, optional, nullable)
- `primary_org_name` (string, optional, nullable)
- `matched_org_name` (string, optional, nullable)
- `investigated_by` (string, optional, nullable)
- `investigated_at` (datetime, optional, nullable)
- `resolution_notes` (string, optional, nullable) — Present when sharing_level is "full_investigation".
- `updated_at` (datetime, optional)

## Errors

### 401 Unauthorized Error

Missing or invalid API key.

- `error` (string, required) — Short error code.
- `status_code` (integer, required) — HTTP status code.
- `detail` (string, optional) — Human-readable error description.

### 403 Forbidden Error

Your organization is not involved in this match.

- `any`

### 404 Not Found Error

Resource not found.

- `error` (string, required) — Short error code.
- `status_code` (integer, required) — HTTP status code.
- `detail` (string, optional) — Human-readable error description.

### 422 Unprocessable Entity Error

Request validation failed.

- `error` (string, required) — Short error code.
- `status_code` (integer, required) — HTTP status code.
- `detail` (string, optional) — Human-readable error description.

## Examples

**Request**

```json
{
  "status": "new"
}
```

**Response**

```json
{
  "id": "cm_abc123",
  "consortium_id": "string",
  "match_type": "face",
  "status": "new",
  "created_at": "2024-01-15T09:30:00Z",
  "face_similarity_score": 1.1,
  "name_mismatch": true,
  "dob_mismatch": true,
  "document_type_mismatch": true,
  "document_number_match": true,
  "email_match": true,
  "phone_match": true,
  "device_match": true,
  "days_between": 1,
  "ghost_student_score": 1,
  "ghost_student_tier": "pass",
  "primary_session_id": "string",
  "primary_org_id": "string",
  "matched_session_id": "string",
  "matched_org_id": "string",
  "primary_org_name": "string",
  "matched_org_name": "string",
  "investigated_by": "string",
  "investigated_at": "2024-01-15T09:30:00Z",
  "resolution_notes": "string",
  "updated_at": "2024-01-15T09:30:00Z"
}
```

**SDK Code**

```python
import requests

url = "https://api.withverifa.com/api/v1/consortiums/consortium_id/matches/match_id"

payload = { "status": "new" }
headers = {
    "X-API-Key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.withverifa.com/api/v1/consortiums/consortium_id/matches/match_id';
const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"status":"new"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.withverifa.com/api/v1/consortiums/consortium_id/matches/match_id"

	payload := strings.NewReader("{\n  \"status\": \"new\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-API-Key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.withverifa.com/api/v1/consortiums/consortium_id/matches/match_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"status\": \"new\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.withverifa.com/api/v1/consortiums/consortium_id/matches/match_id")
  .header("X-API-Key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"status\": \"new\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.withverifa.com/api/v1/consortiums/consortium_id/matches/match_id', [
  'body' => '{
  "status": "new"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-API-Key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.withverifa.com/api/v1/consortiums/consortium_id/matches/match_id");
var request = new RestRequest(Method.PATCH);
request.AddHeader("X-API-Key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"status\": \"new\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-API-Key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = ["status": "new"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.withverifa.com/api/v1/consortiums/consortium_id/matches/match_id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```