List possible duplicates
List the pairs of contacts in one of your vaults that look like the same person, strongest resemblance first.
Two signals put a pair on this list. Names that resemble each other, and an exact shared value in a field your structure marks as identifying, which is what catches a pair whose names do not resemble each other at all. The reasons say which fired.
The list is worked out on a queue, not while you are reading it. Creating or renaming a contact queues a look at that contact, and a nightly pass looks at every vault, which is what notices a template that has just gained an identifying field. So a pair created a second ago may not be here yet.
A pair somebody has ruled out is never in the list again. A vault with nothing doubled answers with an empty list rather than an error.
Nothing here merges anything. This says two records might be one person, and a person decides.
This endpoint also answers QUERY, with the same parameters sent in the request body. How QUERY works.
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.
Returns
A page of pairs, and how many there are in all. A vault belonging to somebody else answers 404.
The pairs on this page. An empty list rather than an error when there are none.
One 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.
Where you are in the collection.
The page this is, counting from 1.
How many one page holds, which is the size that was asked for once it has been brought into the allowed range.
How many pairs there are in all, not how many are on this page.
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.