By vvluc@staple.io / josh@staple.io / hello@staple.io
\nSee our demo at https://www.staple.io/demo if you would wish to sample the scanning using a simple drag and drop interface before using the API directly.
\nEverything relating to the Staple platform and scanning invoice, receipts and other documents! Just send up an invoice or receipt, and the API will return a JSON containing all data the could be extracted, along with details of where that information was on the page, and a new tagged image of the original document. This API is optimized for computer generated PDFs, which will have the best performance. However, pdf scans, png, jpeg, tiff, jfif, and docx are also supported.
\nPlease expect the API to change and improve over the coming weeks and months as the models are being constantly improved at Staple. The values and dictionaries key of returned JOSN will not be removed, however new ones may be added.
\nThe API is load balanced, and should be able to handle a significant number of requests in parallel, but we appreciate your patience with any issues that may occur regarding dropped responses. We recommend testing with no more that 10 parallel requests at a time.
\nStaple AI reserves the right to make changes to the API, including registration process, access and response values at any time. That means that the returned values you see now are not fixed, and may be subject to change.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Documentation for Staples REST APIs","slug":"documentation-for-staples-rest-apis"}],"owner":"726097","collectionId":"308bf21d-85e5-4923-909e-4a582499367a","publishedId":"2sA3s4nAx5","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"8074ff"},"publishDate":"2025-12-02T06:04:50.000Z"},"item":[{"name":"VERSION 1","item":[{"name":"Users","item":[{"name":"Get User information","id":"fc44fda3-68bf-4a40-a716-e7c5a4c003cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.staple.io/v1/users/personal","description":"This endpoint retrieves all the profile information of the user's account.
\nRegister a new user by providing the relevant information related to the user profile, billing, organisation details and subscription plan
\n{\n \"user\": {\n \"email\": String | required,\n \"password\": String | required,\n \"firstName\": String | required,\n \"lastName\": String | required,\n \"position\": String | required,\n \"phoneNumber\": String | required\n },\n \"billing\": {\n \"address\": String | optional,\n \"city\": String | optional,\n \"country\": String | required,\n \"postCode\": String | required,\n \"phoneNumber\": String | required\n },\n \"organisation\": {\n \"address\": String | optional,\n \"city\": String | optional,\n \"name\": String | required,\n \"country\": String | required,\n \"postCode\": String | required,\n \"phoneNumber\": String | required,\n \"businessCode\": String | required,\n \"email\": String | required\n },\n \"stripeSubs\": {\n \"cardSource\": String | optional,\n \"coupon\": String | optional,\n \"plans\": Array | optional | default: ['STAPLE_CUSTOMER_PLAN_V1']\n }\n}\n\nLogin to the user account with your email and password
\n{\n \"credential\": {\n \"email\": String | required,\n \"password\": String | required\n }\n}\n\nThis endpoint allows you to get a list of your team members.
\n{\n \"pagination\": {\n \"skip\": Int | optional | default: 0,\n \"take\": Int | optional | default: 10\n }\n}\n\nThis endpoint allows you to retrieve a list of your team members in a specific queue.
\nThis endpoint makes an HTTP POST request to retrieve a list of your team members' email addresses.
\n{\n \"pagination\": {\n \"skip\": Int | optional | default: 0,\n \"take\": Int | optional | default: 10\n }\n}\n\nThis endpoint allows you to add employees to your team by providing their email addresses.
\n{\n \"employees\": Array(String) | required | array contains member emails\n}\n\nUpdate your account password by providing your current password and the new password you want to change to.
\n{\n \"currentPassword\": String | required,\n \"newPassword\": String | required,\n \"confirmPassword\": String | required\n}\n\nUpdate your personal details such as first name, last name, phone number and position.
\n{\n \"info\": {\n \"firstName\": String | required,\n \"lastName\": String | required,\n \"phoneNumber\": String | required,\n \"position\": String | required\n }\n}\n\nDelete your user account. It requires your password to do so.
\n{\n \"password\": String | required\n}\n\nUpdate the company information of the account.
\n{\n \"info\": {\n \"name\": String | required,\n \"address\": String | required,\n \"email\": String | required,\n \"postCode\": String | required,\n \"city\": String | required,\n \"country\": String | required,\n \"businessCode\": String | required\n }\n}\n\nGet your billing information including subscription plan information, next billing date, invoices, payment card information and billing contact details.
\n{\n \"invoiceLimit\": Int | optional | default: 10\n}\n\n| Attribute | Type | Description |
|---|---|---|
getBilling | Object | Contains all response information |
1. subscription | Object | Subscription information |
+ id | String | Subscription id |
+ nextBilling | String | Next billing date |
+ total | String | Total invoice amount |
+ plans | Array | See[plans] |
2. invoice | Object | Seeinvoice |
3. card | Object | Card detail information |
+ id | String | Card id |
+ exp_month | String | Card expiration month |
+ exp_year | String | Card expiration year |
+ last4 | String | The last 4 digits of the card |
+ name | String | Card name |
+ brand | String | Card brand |
4. billing | Object | Billing detail information |
+ address | String | Billing address |
+ city | String | Billing city |
+ country | String | Billing country |
+ postCode | String | Billing postCode |
+ phoneNumber | String | Billing phone number |
Get information about all your invoices till date.
\n{\n \"pagination\": {\n \"limit\": Int | optional | default: 10,\n \"next\": String | optional| default: empty,\n \"prev\": String | optional| default: empty\n }\n}\n\nUpdate billing contact details such as your address or phone number.
\n{\n\"info\": {\n \"address\": String | required,\n \"postCode\": String | required,\n \"city\": String | required,\n \"country\": String | required,\n \"phoneNumber\": String | required\n }\n}\n\nGet the list of all your groups, their details and the queues that exist in each of the groups.
\nCreate a new group in your Staple account to add queues later.
\n{\n \"name\": String | required\n}\n\nDelete a specific group in your staple account.
\nThis section concerns groups. Groups contain queues which then contain documents. Remember to create a group to then add a queue!
\n","_postman_id":"8d210b8c-aa9a-4e11-91ca-7f33667d8422","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"308bf21d-85e5-4923-909e-4a582499367a","id":"308bf21d-85e5-4923-909e-4a582499367a","name":"Staple API documentation","type":"collection"}}},{"name":"Queues","item":[{"name":"Get Queue By ID","id":"d607d3c2-328e-4f57-b90a-5207212d7b33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.staple.io/v1/queues/{queueId}","description":"Get queue information by passing in queue ID.
\nGet information about queues within a group specified using its group ID.
\nCreate a new queue by stating the new queues name, group id, language and other relevant information
\n{\n \"input\": {\n \"gid\": Int | required,\n \"name\": String | required,\n \"accountType\": String | optional,\n \"supplier\": String | optional,\n \"customer\": String | optional,\n \"modelId\": Int | optional,\n \"useCreatedModel\": Boolean | optional,\n \"automation\": Boolean | optional | default: False,\n \"docType\": String | required | values:(INVOICE|RECEIPT|PASSPORT|NRIC|BANKSTAT|EVN|VID|MRC),\n \"language\": String | required | values:(EN|MULTI|VIET)\n },\n \"members\": Array(String) | optional | array contains member emails\n}\n\n| Attribute | Type | Description |
|---|---|---|
| createQueue | Object | Contains all response information |
| 1. id | Int | Queue id |
| 2. uid | Int | Queue owner id |
| 3. gid | Int | Group id |
| 4. name | String | Queue name |
| 5. supplier | String | Supplier name |
| 6. customer | String | Customer name |
| 7. tags | String | Queue tags |
| 8. docType | String | Queue with document type.See |
| 9. language | String | Queue language. Either EN, MULTI, VIET |
| 10. createdAt | Date | Queue created date |
| 11. documentCount | Int | Total document number |
Assign a single member based to list of queues provided.
\n{\n \"queues\": Array(Int) | required | array contains queue ids\n}\n\nAssign a list of members to the specified queue.
\n{\n \"members\": Array(Int) | required | array contains member ids\n}\n\nRemove members from a queue by providing the desired list of members to provide and the queue id.
\n{\n \"members\": Array(Int) | required | array contains member ids\n}\n\nUpdate queue information such as name, document type, customer name, language and etc
\n{\n \"input\": {\n \"name\": String | required,\n \"accountType\": String | optional,\n \"supplier\": String | optional,\n \"customer\": String | optional,\n \"docType\": String | optional | values:(INVOICE|RECEIPT|PASSPORT|NRIC|BANKSTAT|EVN|VID|MRC),\n \"modelId\": Int | optional,\n \"useCreatedModel\": Boolean | optional,\n \"language\": String | optional | values:(EN|MULTI|VIET),\n \"xeroAccount\": Int | optional,\n \"automation\": Boolean | optional,\n \"gid\": Int | optional\n }\n}\n\nMove a specific queue from one group to another group.
\nPermanently delete the specified queue.
\nGet information about an existing model template by providing its model id.
\nGet the list of models that the account has created or has access to.
\nGet basic model information such as name, language, and etc.
\nCreate a new model by providing relevant model information. You may also state the members who should have access to the model
\n{\n \"input\": {\n \"name\": String | required,\n \"language\": String | required | values:(EN|MULTI)\n },\n \"members\": Array(Int) | optional | array contains member ids\n}\n\nAdd a list of members to collaborate on a model you are created or have access to.
\n{\n \"members\": Array(Int) | optional | array contains member ids\n}\n\nUpload samples documents to a model you are working on.
\nGet the model templates that are used by any specific model.
\n{\n \"input\": {\n \"mid\": Int | required | model id,\n \"status\": String | required | values:(RECEIVED|COMPLETED|REMOVED)\n },\n \"pagination\": {\n \"skip\": Int | optional | default: 0,\n \"take\": Int | optional | default: 10\n }\n}\n\nTrigger a rescan on all model templates for a specific model.
\n{\n \"templateIds\": Array | required | An array contains model template ids,\n \"mid\": Int | required | model id\n}\n\nRemove templates in a specific model by stating their template IDs.
\n{\n \"templateIds\": Array | required | An array contains model template ids,\n \"mid\": Int | required | model id,\n \"status\": String | required | values(RECEIVED|COMPLETED|REMOVED)\n}\n\nUpdate model information such as name, language and etc.
\n{\n \"input\": {\n \"name\": String | optional,\n \"language\": String | optional | values:(EN|MULTI),\n \"defaultJsonTemplateId\": Object | optional\n }\n}\n\nRemove a member from the model you are working on by specifying member and model id.
\nGet a document by specifying its ID.
\nGet the image of a document by specifying the doc ID and the page number of the image within the document.
\nGet a list of all the documents and their status within a single queue.
\n{\n \"filter\": {\n \"qid\": Int | required,\n \"status\": String | required | values:(RECEIVED|COMPLETED|EXPORTED|REMOVED|REJECTED|EXPORT_FAILED),\n \"skip\": Int | optional | default: 0,\n \"take\": Int | optional | default: 10,\n \"sort\": Object | optional,\n \"search\": String | optional\n }\n}\n\nUpload documents into a queue by sending the file and stating the queue ID.
\nProvide an array of documents that you would like to delete.
\n{\n \"docIds\": Array(Int) | required | array contains document ids\n}\nDownload document files by stating the desire array of doc IDs.
\n{\n \"docIds\": Array(Int) | required | array contains document ids\n}\n\n