{"info":{"_postman_id":"403a7d1e-ea85-4d64-a2ce-e7fd251fc87e","name":"Fiscal Lens API v1","description":"

This endpoint processes a document file for VAT-related information. It accepts a file upload and returns the extracted data related to VAT registration

/

/doc-processing

Key things to note

You must use a valid vat pdf document (that is not scanned) to send requests to the API endpoints.
\n
The API has rate and usage limits.
\n
The API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP 301 redirect to the corresponding HTTPS resources.
\n
The API returns request responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.
\n

Authentication

YOu require a key which you can get from the Five team.

Authentication error response

If an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.

Rate and usage limits

API access rate limits apply at a per-API key basis in unit time. The limit is 10 requests per minute. Also, depending on your plan, you may have usage limits. If you exceed either limit, your request will return an HTTP 429 Too Many Requests status code.

Each API response returns the following set of headers to help you identify your use status:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Description
`X-RateLimit-Limit`	The maximum number of requests that the consumer is permitted to make per minute.
`X-RateLimit-Remaining`	The number of requests remaining in the current rate limit window.
`X-RateLimit-Reset`	The time at which the current rate limit window resets in UTC epoch seconds.

500 response

An HTTP 500 response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes. If the outage persists or you receive any other form of an HTTP 5XX error, contact support.

Need some help?

Feel free to reach out to the Five team/

Cell : +263 778 115 084.

Email: tmuranda1@gmail.com

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"31082195","collectionId":"403a7d1e-ea85-4d64-a2ce-e7fd251fc87e","publishedId":"2sB2x6jqzA","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-06-25T12:46:06.000Z"},"item":[{"name":"process-document","event":[{"listen":"test","script":{"id":"e2f1e7d5-7e22-4a23-a2a2-8a0772a27c45","exec":["pm.test(\"Response status code is 400\", function () {"," pm.expect(pm.response.code).to.eql(400);","});","","","pm.test(\"Response contains a success boolean field\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData).to.have.property('success').that.is.a('boolean');","});","","","pm.test(\"Error message should be a string\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.error).to.be.a('string');","});","","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","","pm.test(\"Error field is present when status is 400\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.error).to.exist;","});"],"type":"text/javascript","packages":{}}}],"id":"6268d8d4-9892-4daa-aa9d-3cc39d5bab0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","uuid":"444825a1-c514-45f9-aa02-a03665bdd7b3","src":"/C:/Users/Ropafadzo Muridzi/Downloads/Triple Tee Safety VAT ReG Certificate.pdf"}]},"url":"https://vat-doc-processing-backend.vercel.app/api/v1/docprocessing","description":"

API Endpoint: Document Processing

This endpoint processes a document file for VAT-related information. It accepts a file upload and returns the extracted data related to VAT registration.

Request

Method: POST
\n
URL: https://vat-doc-processing-backend.vercel.app/api/v1/docprocessing
\n
Request Body: Form-data
\n
- file (type: file): The document file that needs to be processed.
\n

Response

Status Code: 200
\n
Content-Type: application/json
\n
{ \"message\": \"\", \"success\": true, \"data\": { \"regOperator\": \"\", \"regTradeName\": \"\", \"tinNumber\": \"\", \"vatNumber\": \"\" }}
\n
- message: A string that may contain additional information about the processing result.
  \n
- success: A boolean indicating whether the processing was successful.
  \n
- data: An object containing the following fields:
  \n
  - regOperator: The registered operator's information.
    \n
  - regTradeName: The registered trade name.
    \n
  - tinNumber: The Tax Identification Number.
    \n
  - vatNumber: The Value Added Tax number.
    \n
  \n
\n

This API is designed to facilitate the extraction of VAT-related information from uploaded documents, providing a structured response to the user.

\n","urlObject":{"protocol":"https","path":["api","v1","docprocessing"],"host":["vat-doc-processing-backend","vercel","app"],"query":[{"disabled":true,"key":"","value":null}],"variable":[]}},"response":[{"id":"b2070b9e-2529-4eab-93a4-c3b0e13e983f","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","uuid":"444825a1-c514-45f9-aa02-a03665bdd7b3","src":"/C:/Users/Ropafadzo Muridzi/Downloads/Triple Tee Safety VAT ReG Certificate.pdf"}]},"url":{"raw":"https://vat-doc-processing-backend.vercel.app/api/v1/docprocessing","protocol":"https","host":["vat-doc-processing-backend","vercel","app"],"path":["api","v1","docprocessing"],"query":[{"key":"","value":null,"type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"public, max-age=0, must-revalidate"},{"key":"Content-Length","value":"194"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 12 Jun 2025 11:31:37 GMT"},{"key":"Etag","value":"W/\"c2-+Sts6qVsMS8gUAw66nKy2on/eqY\""},{"key":"Server","value":"Vercel"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"X-Powered-By","value":"Express"},{"key":"X-Vercel-Cache","value":"MISS"},{"key":"X-Vercel-Id","value":"cpt1::iad1::lp66q-1749727892625-27f9e79c7a38"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Document processed successfully\",\n \"success\": true,\n \"data\": {\n \"regOperator\": \"Nuvert Trading (Pvt) Ltd\",\n \"regTradeName\": \"Triple Tee Safety\",\n \"tinNumber\": \"2000505850\",\n \"vatNumber\": \"220163920\"\n }\n}"},{"id":"8aca1971-2bfe-4f9a-b8ad-c611d977776e","name":"Failed","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","uuid":"444825a1-c514-45f9-aa02-a03665bdd7b3","src":"/C:/Users/Ropafadzo Muridzi/Downloads/enernet zwg invoice.pdf"}]},"url":{"raw":"https://vat-doc-processing-backend.vercel.app/api/v1/docprocessing","protocol":"https","host":["vat-doc-processing-backend","vercel","app"],"path":["api","v1","docprocessing"],"query":[{"key":"","value":null,"type":"text","disabled":true}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"public, max-age=0, must-revalidate"},{"key":"Content-Length","value":"45"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 25 Jun 2025 14:35:25 GMT"},{"key":"Etag","value":"W/\"2d-iXb5U1GvXV6X99C/FQb2kx2EtHo\""},{"key":"Server","value":"Vercel"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"Vary","value":"Origin"},{"key":"X-Powered-By","value":"Express"},{"key":"X-Vercel-Cache","value":"MISS"},{"key":"X-Vercel-Id","value":"cpt1::iad1::pgbfz-1750862117788-f4bb66081707"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"INVALID DOCUMENT.\"\n}"}],"_postman_id":"6268d8d4-9892-4daa-aa9d-3cc39d5bab0a"},{"name":"Welcome","event":[{"listen":"test","script":{"id":"b47bfe54-5d56-45f4-8a73-d7d21a2106d3","exec":[""],"type":"text/javascript","packages":{}}}],"id":"ac13d27f-031f-44c9-b341-170869249193","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://vat-doc-processing-backend.vercel.app/","description":"

GET Request to the Application Root

This endpoint serves as the entry point to the application. When a GET request is made to https://vat-doc-processing-backend.vercel.app/, the server responds with a welcome message indicating successful access to the application.

Request Parameters

None: This endpoint does not require any request parameters.

Expected Response

Status Code: 200 OK
\n
Content-Type: text/html
\n
Response Body: A simple HTML message welcoming the user to the application.
\n

Notes

This endpoint is primarily used to verify that the application is up and running. It does not perform any data processing or retrieval.

\n","urlObject":{"protocol":"https","path":[""],"host":["vat-doc-processing-backend","vercel","app"],"query":[],"variable":[]}},"response":[{"id":"32cadb20-bd7d-4dd3-936b-81b7c4242568","name":"Welcome","originalRequest":{"method":"GET","header":[],"url":"https://vat-doc-processing-backend.vercel.app/"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Age","value":"0"},{"key":"Cache-Control","value":"public, max-age=0, must-revalidate"},{"key":"Content-Length","value":"31"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Date","value":"Thu, 12 Jun 2025 11:32:29 GMT"},{"key":"Etag","value":"W/\"1f-xR69TudzMlCkzlz1ibnLgzUR3uc\""},{"key":"Server","value":"Vercel"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"X-Powered-By","value":"Express"},{"key":"X-Vercel-Cache","value":"MISS"},{"key":"X-Vercel-Id","value":"cpt1::iad1::gd5kq-1749727949851-a3171c120826"}],"cookie":[],"responseTime":null,"body":"Welcome here to the application"}],"_postman_id":"ac13d27f-031f-44c9-b341-170869249193"}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""]}},{"listen":"test","script":{"type":"text/javascript","exec":[""]}}],"variable":[{"id":"bd323cb7-0de1-4fc3-b7ba-42491e1cd82d","key":"baseUrl","value":"https://farming-simulator.pstmn.io"}]}