QFind anything/

Retrieve a match

Retrieves a match by ID. Returns the Match object.

Parameters

id(string)required

The ID of the match (path parameter).

GET/matches/:id

curl -X GET "http://localhost:8000/api/v1/matches/089fafeb-bfb2-491a-9fb3-718118e808be" \
  -H "X-Api-Key: $API_KEY" \
  -H "X-Tenant-Id: $TENANT_ID" \
  -H "X-Environment: production"

Response

{
  "id": "089fafeb-bfb2-491a-9fb3-718118e808be",
  "tenantId": "tenant_abc123",
  "environment": "production",
  "incomingTransactionId": "tran_inc_acme_2Kp1GH0SLIjDWdEL",
  "expectedTransactionId": "ext_abc123xyz",
  "ledgerMatchId": "lm_xyz789",
  "confidence": 0.95,
  "embeddingSimilarity": 0.92,
  "amountScore": 1,
  "dateScore": 0.85,
  "referenceMatch": false,
  "explanation": "Merchant and amount match",
  "matchedFields": {
    "merchant": true,
    "amount": true,
    "date": true,
    "description": false,
    "reference": false
  },
  "rank": 1,
  "status": "PENDING",
  "autoMatched": false,
  "acceptedAt": null,
  "rejectedAt": null,
  "acceptedBy": null,
  "rejectedBy": null,
  "rejectionReason": null,
  "createdAt": "2025-02-01T10:00:00.000Z",
  "updatedAt": "2025-02-01T10:00:00.000Z",
  "incomingTransaction": {
    "id": "tran_inc_acme_2Kp1GH0SLIjDWdEL",
    "merchant": "Amazon Web Services",
    "amount": 300,
    "direction": "CREDIT",
    "currency": "USD",
    "transactionDate": "2024-01-15"
  },
  "expectedTransaction": {
    "id": "ext_abc123xyz",
    "merchant": "Amazon Web Services",
    "amount": 299.99,
    "direction": "CREDIT",
    "currency": "USD",
    "expectedDate": "2025-02-15"
  }
}