Get Matching Document Tuple In Detail

POST

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

POST

/v1/matching/tuples

$ curl -X POST https://api.staple.io/v1/matching/tuples \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json"

200Get Matching Document Tuple In Detail

1 {
2   "getMatchingDocumentTuples": {
3     "data": [
4       {
5         "collectionId": 3,
6         "createdAt": 1712303411471,
7         "documentFieldComparisonTuples": [
8           {
9             "collectionVersionId": null,
10             "createdAt": "2024-04-20T04:03:43.184Z",
11             "documentTupleId": 1593,
12             "elements": [
13               {
14                 "UIType": "Text",
15                 "createdAt": "2024-04-20T04:03:43.184Z",
16                 "documentFieldComparisonTupleId": 6098,
17                 "documentTupleElementId": 4349,
18                 "id": 13375,
19                 "name": "Invoice Number",
20                 "ruleTupleElementId": 5261,
21                 "type": "field",
22                 "uid": "1",
23                 "updatedAt": "2024-04-20T04:03:43.184Z",
24                 "value": "30,000",
25                 "valuemulti": "30,000"
26               },
27               {
28                 "UIType": "Text",
29                 "createdAt": "2024-04-20T04:03:43.184Z",
30                 "documentFieldComparisonTupleId": 6098,
31                 "documentTupleElementId": 4350,
32                 "id": 13376,
33                 "name": "Invoice Number",
34                 "ruleTupleElementId": 5260,
35                 "type": "field",
36                 "uid": "1",
37                 "updatedAt": "2024-04-20T04:03:43.184Z",
38                 "value": "SD190006-C",
39                 "valuemulti": "# SD190006-C"
40               }
41             ],
42             "id": 6098,
43             "isMatch": false,
44             "ruleTuple": {
45               "auto": false,
46               "collectionId": 3,
47               "collectionVersionId": "dfb0c18a-cde9-4d62-bed4-594e86922472",
48               "columnName": "New column",
49               "createdAt": "2024-04-17T05:51:38.768Z",
50               "id": 2613,
51               "type": "FvF",
52               "uid": "1",
53               "updatedAt": "2024-04-17T05:51:38.768Z",
54               "useAsColumn": true
55             },
56             "ruleTupleId": 2613,
57             "uid": "1",
58             "updatedAt": "2024-04-20T04:03:43.184Z"
59           }
60         ],
61         "documentTupleElements": [
62           {
63             "createdAt": 1713333126329,
64             "documentId": 5656,
65             "documentName": "Invoice_20200114.png",
66             "documentTupleId": 1593,
67             "id": 4349,
68             "queueId": 29,
69             "status": "CREATED",
70             "uid": 1,
71             "updatedAt": 1713333126329
72           },
73           {
74             "createdAt": 1713333126329,
75             "documentId": 6196,
76             "documentName": "11.pdf",
77             "documentTupleId": 1593,
78             "id": 4350,
79             "queueId": 71,
80             "status": "CREATED",
81             "uid": 1,
82             "updatedAt": 1713333126329
83           }
84         ],
85         "id": 1593,
86         "isMatched": false,
87         "status": "REVIEWED",
88         "uid": 1,
89         "updatedAt": 1713585823244
90       }
91     ],
92     "pageInfo": {
93       "hasNextPage": false,
94       "hasPreviousPage": false,
95       "lastCursor": 1593
96     },
97     "total": 1
98   }
99 }

Retrieves the matching document tuples of a collection, filtered by status and version, with optional text search (searchBy) and pagination (skip/take). The response contains the tuple list, pagination info, and the total count. Note that although this uses the POST method, it is a read operation — the filters are sent in the request body.

Authentication

x-api-keystring

API key issued by Staple.

AuthorizationBearer

JWT obtained from the login endpoint.

Request

This endpoint expects an object.

statusstringOptional

collectionIdintegerOptional

searchBystringOptional

versionstringOptional

paginationobjectOptional

Authentication

Request

Response