Get Matching Detail

GET

https://api.staple.io/v1/matching/tuples/:tupleId

GET

/v1/matching/tuples/:tupleId

$ curl https://api.staple.io/v1/matching/tuples/tupleId \
>      -H "x-api-key: <apiKey>"

200Get Matching Detail

1 {
2   "getMatchingDocumentTupleComparisonsAndDocuments": {
3     "comparisonTuples": [
4       {
5         "createdAt": 1714146366169,
6         "documentTupleId": 1541,
7         "elements": [
8           {
9             "createdAt": 1714146366169,
10             "documentFieldComparisonTupleId": 6318,
11             "documentTupleElementId": 4466,
12             "id": 13829,
13             "name": "",
14             "ruleTupleElementId": 5243,
15             "uid": 1,
16             "updatedAt": 1714146366169,
17             "value": null,
18             "valuemulti": null
19           },
20           {
21             "createdAt": 1714146366169,
22             "documentFieldComparisonTupleId": 6318,
23             "documentTupleElementId": 4467,
24             "id": 13830,
25             "name": "",
26             "ruleTupleElementId": 5243,
27             "uid": 1,
28             "updatedAt": 1714146366169,
29             "value": null,
30             "valuemulti": null
31           },
32           {
33             "createdAt": 1714146366169,
34             "documentFieldComparisonTupleId": 6318,
35             "documentTupleElementId": 4468,
36             "id": 13831,
37             "name": "",
38             "ruleTupleElementId": 5242,
39             "uid": 1,
40             "updatedAt": 1714146366169,
41             "value": null,
42             "valuemulti": null
43           }
44         ],
45         "id": 6318,
46         "isMatch": true,
47         "ruleTupleId": 2607,
48         "uid": 1,
49         "updatedAt": 1714146366169
50       }
51     ],
52     "documents": [
53       {
54         "createdAt": 1714146366169,
55         "documentId": 86,
56         "documentName": "16952ab0-ec1e-11ea-a538-8f79995a0d7e-5-(1).jpg",
57         "documentTupleId": 1541,
58         "id": 4466,
59         "queueId": 3,
60         "status": "CREATED",
61         "uid": 1,
62         "updatedAt": 1714146366169
63       },
64       {
65         "createdAt": 1714146366169,
66         "documentId": 5719,
67         "documentName": "botan.jpg",
68         "documentTupleId": 1541,
69         "id": 4467,
70         "queueId": 3,
71         "status": "CREATED",
72         "uid": 1,
73         "updatedAt": 1714146366169
74       },
75       {
76         "createdAt": 1714146366169,
77         "documentId": 25835,
78         "documentName": "invoice.pdf",
79         "documentTupleId": 1541,
80         "id": 4468,
81         "queueId": 1,
82         "status": "CREATED",
83         "uid": 1,
84         "updatedAt": 1714146366169
85       }
86     ]
87   }
88 }

Retrieves the full detail of a single matching document tuple: the comparison results for each matching rule and the documents that make up the tuple. Use this to inspect why a tuple matched or failed to match.

Authentication

x-api-keystring

API key issued by Staple.

AuthorizationBearer

JWT obtained from the login endpoint.

Path parameters

tupleIdstringRequired

Authentication

Path parameters

Response