Skip to content

Restore a dismissed possible-duplicate pair to the queue

POST
/duplicate-suggestions/{id}/restore
curl --request POST \
--url https://api.tovarifinancial.com/duplicate-suggestions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/restore \
--header 'Authorization: Bearer <token>'

Restores only from dismissed; a missing, other-org, open or confirmed pair answers 404. A redelivery therefore answers 404 rather than replaying the original 200. No X-Idempotency-Key is declared or read (KAN-1359) — replay safety here is structural, not key-derived. A key sent anyway is ignored. A non-UUID id answers 400 before any database work. A database-level access refusal answers 403 DATABASE_ERROR, a code the shared 403 entry (TenantGateError) does not name.

id
required
string format: uuid

Duplicate suggestion id

The pair, re-read after the write

Media typeapplication/json
object
data
required
object
suggestion
required
object
id
required
string format: uuid
detectedAt
required
string format: date-time
origin
required
string
Allowed values: sync manual-entry
dateDeltaDays
required

SIGNED whole days, bank MINUS manual.

integer
amountCents
required

Signed — equal on both legs by construction.

integer format: int64
descriptorInformative
required

Detection-time verdict. Always false for ‘bank-vs-bank’.

boolean
bankLeg
required
object
transactionId
required
string
accountId
required
string
accountName
required
string
accountType
required
string
nullable
accountMaskLast4
required
string
nullable
institution
required
string
nullable
transactionDate
required

Calendar date, ‘YYYY-MM-DD’

string
amountCents
required

SIGNED ledger cents, exactly as stored.

integer format: int64
description
required
string
bankDescription
required

Raw bank text. UNTRUSTED — render as text, never as markup.

string
nullable
payeeName
required
string
nullable
manualLeg
required
object
transactionId
required
string
accountId
required
string
accountName
required
string
accountType
required
string
nullable
accountMaskLast4
required
string
nullable
institution
required
string
nullable
transactionDate
required

Calendar date, ‘YYYY-MM-DD’

string
amountCents
required

SIGNED ledger cents, exactly as stored.

integer format: int64
description
required
string
bankDescription
required

Raw bank text. UNTRUSTED — render as text, never as markup.

string
nullable
payeeName
required
string
nullable
survivorTransactionId
required

SERVER-DECIDED — echo it back; never guess a survivor.

string
consumedTransactionId
required
string
requiresPendingConfirmation
required
boolean
adoptedCategoryName
required
string
nullable
status
required
string
Allowed values: open confirmed dismissed
pairKind
required

For ‘bank-vs-bank’, bankLeg is the SURVIVOR and manualLeg is the surplus bank copy proposed for retirement.

string
Allowed values: manual-vs-bank bank-vs-bank
copyCount
required

BANK KIND ONLY. Frozen detection-time evidence, not recomputed on read.

integer
nullable
surplusCount
required

BANK KIND ONLY. copyCount - 1, frozen on the same terms.

integer
nullable
balanceHazard
required

BANK KIND ONLY. Whether retiring this copy would move the account balance. Recomputed on every read.

object
kind
required
string
Allowed values: clear absorbed unknown
shiftCents
required

SIGNED, PER-RETIREE — this copy’s own amount.

integer format: int64
survivorStatusAfter
required

BANK KIND ONLY. The survivor’s status after a retire. Recomputed on every read.

string
nullable
Allowed values: uncleared pending cleared reconciled
message
string
requestId
required
string
timestamp
required
string format: date-time
Example
{
"data": {
"suggestion": {
"origin": "sync",
"status": "open",
"pairKind": "manual-vs-bank",
"balanceHazard": {
"kind": "clear"
},
"survivorStatusAfter": "uncleared"
}
}
}

Validation failed — see errorCode / fieldErrors

Media typeapplication/json
object
errorCode
required

Machine-readable error code (AUTH_ERROR_CODES).

string
Allowed values: INVALID_EMAIL_FORMAT USER_ALREADY_EXISTS INVALID_INVITE_CODE WRONG_PASSWORD USER_NOT_FOUND AUTHENTICATION_FAILED EXPIRED_CODE INVALID_CODE INVALID_PASSWORD VALIDATION_ERROR SIGNUP_FAILED DATABASE_ERROR SERVICE_UNAVAILABLE PLAID_ERROR IDEMPOTENCY_CONFLICT ACCOUNT_ALREADY_LINKED NOT_FOUND
message
required
string
fieldErrors

Optional field-level validation errors, keyed by field name.

object
key
additional properties
Array<string>
requestId
required
string
timestamp
required
string format: date-time
Example
{
"errorCode": "INVALID_EMAIL_FORMAT"
}

Missing, invalid, or expired bearer token

Media typeapplication/json
object
errorCode
required

Machine-readable error code (AUTH_ERROR_CODES).

string
Allowed values: INVALID_EMAIL_FORMAT USER_ALREADY_EXISTS INVALID_INVITE_CODE WRONG_PASSWORD USER_NOT_FOUND AUTHENTICATION_FAILED EXPIRED_CODE INVALID_CODE INVALID_PASSWORD VALIDATION_ERROR SIGNUP_FAILED DATABASE_ERROR SERVICE_UNAVAILABLE PLAID_ERROR IDEMPOTENCY_CONFLICT ACCOUNT_ALREADY_LINKED NOT_FOUND
message
required
string
fieldErrors

Optional field-level validation errors, keyed by field name.

object
key
additional properties
Array<string>
requestId
required
string
timestamp
required
string format: date-time
Example
{
"errorCode": "INVALID_EMAIL_FORMAT"
}

Authenticated, but the tenant gate refuses the request until the caller resolves a precondition. errorCode is one of EMAIL_NOT_VERIFIED, POLICY_ACCEPTANCE_REQUIRED, or SUBSCRIPTION_REQUIRED, evaluated in exactly that order (contract term CCR-1: email verification first, then policy acceptance, then subscription — so a subscriber who has merely not re-accepted the current policies always sees POLICY_ACCEPTANCE_REQUIRED). A POLICY_ACCEPTANCE_REQUIRED body additionally carries details.outstanding (the policy versions still to accept) and details.firstAcceptance. The SUBSCRIPTION_REQUIRED arm is INERT unless the server-side BILLING_ENABLED flag is exactly the string true; while it is off, only the first two codes are reachable. Not retryable as sent — resolve the named condition, then resend.

Media typeapplication/json
object
errorCode
required

Which precondition refused the request. Evaluated in this order (CCR-1); SUBSCRIPTION_REQUIRED is unreachable while BILLING_ENABLED is not exactly true.

string
Allowed values: EMAIL_NOT_VERIFIED POLICY_ACCEPTANCE_REQUIRED SUBSCRIPTION_REQUIRED
message
required
string
details
object
outstanding
required

Active policy versions the user has not yet accepted.

Array<object>
object
id
required
string format: uuid
policyType
required
string
version
required
integer
title
required
string
firstAcceptance
required

True when the user has accepted no policy before — the client renders the new-signup screen rather than the re-acceptance one.

boolean
requestId
required
string
timestamp
required
string format: date-time
Example
{
"errorCode": "EMAIL_NOT_VERIFIED"
}

Suggestion not found, not owned by the caller org, or not in a state this action accepts

Media typeapplication/json
object
errorCode
required

Machine-readable error code (AUTH_ERROR_CODES).

string
Allowed values: INVALID_EMAIL_FORMAT USER_ALREADY_EXISTS INVALID_INVITE_CODE WRONG_PASSWORD USER_NOT_FOUND AUTHENTICATION_FAILED EXPIRED_CODE INVALID_CODE INVALID_PASSWORD VALIDATION_ERROR SIGNUP_FAILED DATABASE_ERROR SERVICE_UNAVAILABLE PLAID_ERROR IDEMPOTENCY_CONFLICT ACCOUNT_ALREADY_LINKED NOT_FOUND
message
required
string
fieldErrors

Optional field-level validation errors, keyed by field name.

object
key
additional properties
Array<string>
requestId
required
string
timestamp
required
string format: date-time
Example
{
"errorCode": "INVALID_EMAIL_FORMAT"
}

Internal error (no internal detail leaked)

Media typeapplication/json
object
errorCode
required

Machine-readable error code (AUTH_ERROR_CODES).

string
Allowed values: INVALID_EMAIL_FORMAT USER_ALREADY_EXISTS INVALID_INVITE_CODE WRONG_PASSWORD USER_NOT_FOUND AUTHENTICATION_FAILED EXPIRED_CODE INVALID_CODE INVALID_PASSWORD VALIDATION_ERROR SIGNUP_FAILED DATABASE_ERROR SERVICE_UNAVAILABLE PLAID_ERROR IDEMPOTENCY_CONFLICT ACCOUNT_ALREADY_LINKED NOT_FOUND
message
required
string
fieldErrors

Optional field-level validation errors, keyed by field name.

object
key
additional properties
Array<string>
requestId
required
string
timestamp
required
string format: date-time
Example
{
"errorCode": "INVALID_EMAIL_FORMAT"
}

Service temporarily unavailable — errorCode is SERVICE_UNAVAILABLE. A TRANSIENT, RETRYABLE condition rather than a defect in the request: a query that exceeded its time budget, a lost or refused database connection, a saturated connection pool, or an outage at an upstream provider the request depends on (the authentication provider, or the bank data provider on a bank-connection operation). The identical request may succeed on retry — back off briefly and, on a write, resend the same X-Idempotency-Key where the operation accepts one.

Media typeapplication/json
object
errorCode
required

Machine-readable error code (AUTH_ERROR_CODES).

string
Allowed values: INVALID_EMAIL_FORMAT USER_ALREADY_EXISTS INVALID_INVITE_CODE WRONG_PASSWORD USER_NOT_FOUND AUTHENTICATION_FAILED EXPIRED_CODE INVALID_CODE INVALID_PASSWORD VALIDATION_ERROR SIGNUP_FAILED DATABASE_ERROR SERVICE_UNAVAILABLE PLAID_ERROR IDEMPOTENCY_CONFLICT ACCOUNT_ALREADY_LINKED NOT_FOUND
message
required
string
fieldErrors

Optional field-level validation errors, keyed by field name.

object
key
additional properties
Array<string>
requestId
required
string
timestamp
required
string format: date-time
Example
{
"errorCode": "INVALID_EMAIL_FORMAT"
}