Rule a pair out
Say that two contacts the product proposed are two different people.
This is permanent. Detection keeps recomputing and leaves the pair alone from now on, so it is never raised again even though the two still resemble each other, which they will.
Ruling out a pair that is already ruled out answers exactly the same way and changes nothing, so calling this twice is safe.
Path parameters
Sent as JSON. Anything not listed here is ignored.
The id of the vault the contacts live in. A path that is not a uuid answers 404 without a query being run.
The id of a pair this vault proposed.
Returns
The pair as it now reads, with dismissed_at set. A pair in another vault or another account answers 404.
The pair.
Always contact_duplicate_candidate. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from.
The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes.
Everything the record holds.
One of the two contacts.
The other one.
What the first one is called, so a list reads without a second request.
What the second one is called.
How strongly the two resemble each other, 0 to 100. It orders the list and says nothing about certainty.
One entry per signal that fired.
One signal.
Either name, when the two names resemble each other, or field, when the two share a value in a field the structure marks as identifying.
The key of that field. Only on a field signal.
The value the two share. Only on a field signal.
When somebody said these are two different people, null while the pair stands.
When detection last looked at this pair.
Rate limit
Sixty requests per minute, per user, shared by every key and device. Every answer carries the budget left in X-RateLimit-Remaining.
Keys act as you, with exactly the access you have. Make one per integration so you can revoke it alone.