![](\"https://i.imgur.com/1gTG0e7.png\")
\n\nWelcome and thank you for checking out Photon Commerce!
\nOur API enables customers to take invoices in various formats and return structured data to automate invoice processing. It extracts key information from invoices like text, total amount, balance due, tax, vendor name, vendor address, invoice date, invoice due date, invoice number, ship to, bill to, line items and more.
\nThe API returns key information in an organized structured JSON response. Documents can be from various formats and quality, including phone-captured images, scanned documents, Excel or Word documents, and digital PDFs.
\nThe Photon Commerce API is organized around REST. The API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
\nPhoton's services reads the most common languages around the world:
\nArabic, Chinese, Danish, Dutch, English, French, German, Greek, Hebrew, Italian, Japanese, Korean, Portuguese, Russian, Spanish, Thai, Turkish, Vietnamese
\nIf you have any questions, you are welcome to contact Photon Commerce at api @ photoncommerce.com to be set up with an account, or you can register for api keys and credentials by providing your email address and password. The details are provided in the next section.
\nYour credentials carry many privileges, so be sure to keep them secure! Do not share your credentials in publicly accessible areas such as GitHub, client-side code, etc.
\nAuthentication to the API is performed via HTTP Basic Auth. Provide your credentials in the header. All API requests must be made over HTTPS. API requests without authentication will fail.
\nWe provide 2 services:
\nUnique Client_ID for every user. The preset value for this header is a working test credential specially curated for this sample request.
\n","type":"default"},{"key":"AUTHORIZATION","value":"apikey apiphotoncommerce.com:example_test_api_key_1","description":"In the format 'apikey :'. The preset value for this header is a working test credential specially curated for this sample request.
\n","type":"default"},{"key":"PASSWORD","value":"wAIz0y1oyAdKmQ","description":"The password you used for your email registration. The preset value for this header is a working test credential specially curated for this sample request.
\n","type":"default"},{"key":"SECRET-KEY","value":"yz3YLXyPApmWv_srfGMu","description":"Your secret key as a string. The preset value for this header is a working test credential specially curated for this sample request.
\n","type":"default"}],"url":"https://sandbox-api.photoncommerce.com/api/pro?url=https://photon-api-demo.s3.us-west-1.amazonaws.com/demo_docs/02-02-2021_-_TuneGO_2.0.pdf","description":"Example request in Python:
\nimport requests\nurl = \"https://api.photoncommerce.com/api/v4?url=https://photon-api-demo.s3.us-west-1.amazonaws.com/demo_docs/02-02-2021_-_TuneGO_2.0.pdf\"\npayload={}\nheaders = {\n 'CLIENT-ID': '_8z-AyFQ8LRPrg',\n 'AUTHORIZATION': 'apikey apiphotoncommerce.com:example_test_api_key_1',\n 'PASSWORD': 'wAIz0y1oyAdKmQ',\n 'SECRET-KEY': 'yz3YLXyPApmWv_srfGMu'\n}\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\nprint(response.text)\n\nSeeing this error: \"Document Web URL incorrect for these credentials\"? You probably changed the pre-specfied URL of the document to the URL of one of your own documents. The test credentials in this section will only work on our sample documents (URLs mentioned in the code as well as the POST requests). To test our API on your documents, please register to receive personal credientials for using our services. Please check the following section 'Register a free sandbox account' for instructions to register for an account and 'Convert Documents to JSON' to learn how to use your creds to make requests to our API.
\n","urlObject":{"protocol":"https","path":["api","pro"],"host":["sandbox-api","photoncommerce","com"],"query":[{"key":"url","value":"https://photon-api-demo.s3.us-west-1.amazonaws.com/demo_docs/02-02-2021_-_TuneGO_2.0.pdf"}],"variable":[]}},"response":[{"id":"3d5c99e2-6532-44cf-ae0d-9e22b8bc3f93","name":"An Invoice Request","originalRequest":{"method":"POST","header":[{"key":"CLIENT-ID","value":"_8z-AyFQ8LRPrg","type":"default"},{"key":"AUTHORIZATION","value":"apikey apiphotoncommerce.com:example_test_api_key_1","type":"default"},{"key":"PASSWORD","value":"wAIz0y1oyAdKmQ","type":"default"},{"key":"SECRET-KEY","value":"yz3YLXyPApmWv_srfGMu","type":"default"}],"url":{"raw":"https://sandbox-api.photoncommerce.com/api/pro?url=https://photon-api-demo.s3.us-west-1.amazonaws.com/demo_docs/02-02-2021_-_TuneGO_2.0.pdf","protocol":"https","host":["sandbox-api","photoncommerce","com"],"path":["api","pro"],"query":[{"key":"url","value":"https://photon-api-demo.s3.us-west-1.amazonaws.com/demo_docs/02-02-2021_-_TuneGO_2.0.pdf"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Sun, 09 Jan 2022 14:38:48 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"Balance_Due\": 22001.38,\n \"Total\": 22001.38,\n \"Subtotal\": 22001.38,\n \"Shipping\": 0,\n \"Tax\": 0,\n \"Cashback\": 0,\n \"Discount\": 0,\n \"Document_Type\": \"Invoice\",\n \"Invoice_Number\": \"2/02/2021\",\n \"PO_Number\": \"\",\n \"Date\": \"2021-02-03\",\n \"Created\": \"2021-02-03\",\n \"Order_Date\": \"\",\n \"Due_Date\": \"2021-02-10\",\n \"Ship_Date\": \"\",\n \"Delivery_Date\": \"\",\n \"Service_Start_Date\": \"2021-01-18\",\n \"Service_End_Date\": \"2021-01-29\",\n \"Category\": \"Software Services\",\n \"Currency_Code\": \"USD\",\n \"Payment_Terms\": \"\",\n \"Account_Number\": \"\",\n \"Bill_To_Name\": \"TUNEGO, INC.\",\n \"Bill_To_Recipient\": \"\",\n \"Bill_To_Address\": \"32505 Anthem Village Drive, Suite E283 Henderson, NV 89052, United States\",\n \"Bill_To_Address_Line\": \"32505 Anthem Village Drive, Suite E283\",\n \"Bill_To_City\": \"Henderson\",\n \"Bill_To_State\": \"NV\",\n \"Bill_To_Zipcode\": \"89052\",\n \"Bill_To_Vat_Number\": \"\",\n \"Bill_To_Email\": \"\",\n \"Card_Number\": \"\",\n \"Payment_Display_Name\": \"\",\n \"Payment_Type\": \"Transfer\",\n \"Phone_Number\": \"\",\n \"Vat_Number\": \"7010559296\",\n \"Vendor_Name\": \"MOBILE REALITY sp. z. o. o.\",\n \"Vendor_Raw_Name\": \"MOBILE REALITY sp. z. o. o.\",\n \"Vendor_Recipient\": \"\",\n \"Vendor_Email\": \"biuro@mobilereality.pl\",\n \"Vendor_Address\": \"Al. Ks. J. Poniatowskiego 1/K4, 03-901 Warszawa, Poland\",\n \"Vendor_Address_Line\": \"Al. Ks. J. Poniatowskiego 1/K4\",\n \"Vendor_City\": \"Warszawa\",\n \"Vendor_State\": \"\",\n \"Vendor_Zipcode\": \"03-901\",\n \"Vendor_Country\": \"Poland\",\n \"Vendor_Type\": \"\",\n \"Vendor_Phone\": \"\",\n \"Vendor_Fax\": \"\",\n \"Vendor_Website\": \"\",\n \"Vendor_ABN_Number\": \"\",\n \"Vendor_Bank_Name\": \"TransferWise\",\n \"Vendor_Bank_Number\": \"084009519\",\n \"Vendor_Bank_Swift\": \"CMFGUS33\",\n \"Vendor_IBAN\": \"\",\n \"Vendor_Account_Number\": \"9600000000220961\",\n \"Remit_To_Name\": \"MOBILE REALITY sp. z. o. o.\",\n \"Remit_To_Address\": \"Al. Ks. J. Poniatowskiego 1/K4, 03-901 Warszawa, Poland\",\n \"All_Email_Addresses\": \"biuro@mobilereality.pl\",\n \"Ship_To_Name\": \"\",\n \"Ship_To_Address\": \"\",\n \"Carrier\": \"\",\n \"Tracking_Number\": \"\",\n \"Pages\": 1,\n \"Is_Duplicate\": 0,\n \"Notes\": \"odwrotne obciążenie\",\n \"Tax_Lines\": [],\n \"Line_Items\": [\n {\n \"Line\": 1,\n \"SKU\": \"\",\n \"Description\": \"[TuneGO 2.0] React.JS frontend development services\",\n \"Date\": \"\",\n \"QTY\": 160,\n \"Unit\": \"hrs\",\n \"Order\": 0,\n \"Reference\": \"\",\n \"Tax_Rate\": 0,\n \"Tax\": 0,\n \"Type\": \"service\",\n \"Price\": 42.5,\n \"Discount\": 0,\n \"Amount\": 6800\n },\n {\n \"Line\": 2,\n \"SKU\": \"\",\n \"Description\": \"[TuneGO 2.0] React Native mobile development services\",\n \"Date\": \"\",\n \"QTY\": 146.25,\n \"Unit\": \"hrs\",\n \"Order\": 0,\n \"Reference\": \"\",\n \"Tax_Rate\": 0,\n \"Tax\": 0,\n \"Type\": \"service\",\n \"Price\": 42.5,\n \"Discount\": 0,\n \"Amount\": 6215.63\n },\n {\n \"Line\": 3,\n \"SKU\": \"\",\n \"Description\": \"[TuneGO 2.0] Node.JS back-end development\",\n \"Date\": \"\",\n \"QTY\": 205.5,\n \"Unit\": \"hrs\",\n \"Order\": 0,\n \"Reference\": \"\",\n \"Tax_Rate\": 0,\n \"Tax\": 0,\n \"Type\": \"service\",\n \"Price\": 42.5,\n \"Discount\": 0,\n \"Amount\": 8733.75\n },\n {\n \"Line\": 4,\n \"SKU\": \"\",\n \"Description\": \"[TuneGO 2.0] UX/UI/graphics design support\",\n \"Date\": \"\",\n \"QTY\": 9,\n \"Unit\": \"hrs\",\n \"Order\": 0,\n \"Reference\": \"\",\n \"Tax_Rate\": 0,\n \"Tax\": 0,\n \"Type\": \"service\",\n \"Price\": 28,\n \"Discount\": 0,\n \"Amount\": 252\n }\n ],\n \"Raw_Text\": \"Invoice No. 2/02/2021\\nIssue date: Warszawa, 2021-02-03\\nData wykonania usługi: 2021-02-03\\n\\tMobile Reality\\nDue date: 2021-02-10\\nPayment type: Transfer\\n\\nSeller\\t\\t\\t\\t\\t\\t\\tBuyer\\nMOBILE REALITY sp. z o.o.\\t\\t\\t\\t\\tTUNEGO, INC.\\nAl. Ks. J. Poniatowskiego 1/K4\\t\\t\\t\\t\\t32505 Anthem Village Drive, Suite E283\\n03-901 Warszawa, Poland\\t\\t\\t\\t\\tHenderson, NV 89052\\nVAT ID 7010559296\\t\\t\\t\\t\\t\\tUnited States\\n\\tFile Number: 6094078\\nbiuro@mobilereality.pl\\nAccount's owner : Mobile Reality Sp. z o.o.\\nTransferWise\\n19 W 24th Street\\nNew York 10010 United States\\nWire/ACH: 084009519\\nAccount number: 9600000000220961\\nSWIFT: CMFGUS33\\n\\nNo.\\tItem\\t\\t\\t\\t\\t\\tQty\\tUnit net\\tTotal net\\tVAT %\\tVAT amount\\tTotal gross\\n\\tprice\\n1\\t[TuneGO 2.0] React.JS frontend development\\t160 hrs\\t42.50\\t6,800.00\\tN/A\\t0.00\\t6,800.00\\nservices\\n2\\t[TuneGO 2.0] React Native mobile development\\t146.25 hrs\\t42.50\\t6,215.63\\tN/A\\t0.00\\t6,215.63\\nservices\\n3\\t[TuneGO 2.0] Node.JS back-end development\\t205.5 hrs\\t42.50\\t8,733.75\\tΝΙΑ\\t0.00\\t8,733.75\\n4\\t[TuneGO 2.0] UX/UI/graphics design\\tport\\t\\t9 hrs\\t28.00\\t252.00\\tN/A\\t0.00\\t252.00\\n\\tTax rate\\t22,001.38\\tN/A\\t0.00\\t22,001.38\\n\\tTotal\\t22,001.38\\t\\t0.00\\t22,001.38\\n\\tTotal net price\\tUSD 22,001.38\\n\\tVAT amount\\tUSD 0.00\\n\\tTotal gross price\\tUSD 22,001.38\\n\\nNotes:\\t\\t\\\"odwrotne obciążenie\\\"\\nTuneGO 2.0: development period 18.01-29.01.2021\\n\\nTotal due\\t\\tUSD 22,001.38\\nwords: twenty two tho\\tnd and one USD thirty eight cents\\n\\n\\tSeller's signature\\n\\tMateusz Sadowski\\n\\nPage 1 of 1\\t\\t\\t\\t\\t\\t\\t\\t\\t\\t\\t\\t\\t\\tgenerated in Fakturownia.pl\",\n \"Reference_Number\": \"6094078\",\n \"Fraud_Score\": 5,\n \"Risk_Score\": 2,\n \"Anomaly_Score\": 5,\n \"photon_key\": \"\"\n },\n \"message\": \"success\",\n \"status\": \"success\"\n}"}],"_postman_id":"19cdf253-f123-44b5-9205-dfc7957bd53e"},{"name":"Demo: Receipt Request","id":"df31b744-7c62-4b66-8929-7e707c981b73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"CLIENT-ID","value":"_8z-AyFQ8LRPrg","description":"Unique Client_ID for every user. This a working test CLIENT-ID specially created for this sample request.
\n","type":"default"},{"key":"AUTHORIZATION","value":"apikey apiphotoncommerce.com:example_test_api_key_2","description":"In the format 'apikey :'. This is a working test AUTHORIZATION header specially curated for this sample request.
\n","type":"default"},{"key":"PASSWORD","value":"wAIz0y1oyAdKmQ","description":"The password you used for your email registration. This is a working test password specially curated for this sample request.
\n","type":"default"},{"key":"SECRET-KEY","value":"yz3YLXyPApmWv_srfGMu","description":"Your secret key as a string. This a working test secret-key specially curated for this sample request.
\n","type":"default"}],"url":"https://api.photoncommerce.com/api/pro?url=https://photon-api-demo.s3.us-west-1.amazonaws.com/demo_docs/lineitem_receipt.png","description":"Example request in Python:
\nimport requests\nurl = \"https://api.photoncommerce.com/api/v4?url=https://photon-api-demo.s3.us-west-1.amazonaws.com/demo_docs/lineitem_receipt.png\"\npayload={}\nheaders = {\n 'CLIENT-ID': '_8z-AyFQ8LRPrg',\n 'AUTHORIZATION': 'apikey apiphotoncommerce.com:example_test_api_key_2',\n 'PASSWORD': 'wAIz0y1oyAdKmQ',\n 'SECRET-KEY': 'yz3YLXyPApmWv_srfGMu'\n}\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\nprint(response.text)\n\nSeeing this error: \"Document Web URL incorrect for these credentials\"? You probably changed the pre-specfied URL of the document to the URL of one of your own documents. The test credentials in this section will only work on our sample documents (URLs mentioned in the code as well as the POST requests). To test our API on your documents, please register to receive personal credentials for using our services. Please check the following section 'Register a free sandbox account' for instructions to register for an account and 'Convert Documents to JSON' to learn how to use your creds to make requests to our API.
\n","urlObject":{"protocol":"https","path":["api","pro"],"host":["api","photoncommerce","com"],"query":[{"description":{"content":"URL of the document. Do NOT change the value. Public Credentials will only work on our sample invoice and receipt.
\n","type":"text/plain"},"key":"url","value":"https://photon-api-demo.s3.us-west-1.amazonaws.com/demo_docs/lineitem_receipt.png"}],"variable":[]}},"response":[{"id":"7b57fbc3-4b00-4994-915c-2787d5cfb4d7","name":"A Receipt Request","originalRequest":{"method":"POST","header":[{"key":"CLIENT-ID","value":"_8z-AyFQ8LRPrg","type":"default"},{"key":"AUTHORIZATION","value":"apikey apiphotoncommerce.com:example_test_api_key_2","type":"default"},{"key":"PASSWORD","value":"wAIz0y1oyAdKmQ","type":"default"},{"key":"SECRET-KEY","value":"yz3YLXyPApmWv_srfGMu","type":"default"}],"url":{"raw":"https://sandbox-api.photoncommerce.com/api/pro?url=https://photon-api-demo.s3.us-west-1.amazonaws.com/demo_docs/lineitem_receipt.png","protocol":"https","host":["sandbox-api","photoncommerce","com"],"path":["api","pro"],"query":[{"key":"url","value":"https://photon-api-demo.s3.us-west-1.amazonaws.com/demo_docs/lineitem_receipt.png"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Sun, 09 Jan 2022 14:37:47 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"Balance_Due\": 34.95,\n \"Total\": 34.95,\n \"Subtotal\": 32.29,\n \"Shipping\": 0,\n \"Tax\": 2.66,\n \"Tip\": 0,\n \"Cashback\": 0,\n \"Discount\": 0,\n \"Document_Type\": \"Receipt\",\n \"Invoice_Number\": \"\",\n \"PO_Number\": \"\",\n \"Date\": \"2018-10-17\",\n \"Created\": \"2018-10-17\",\n \"Order_Date\": \"2018-10-17\",\n \"Due_Date\": \"\",\n \"Ship_Date\": \"\",\n \"Delivery_Date\": \"\",\n \"Service_Start_Date\": \"2018-10-17\",\n \"Service_End_Date\": \"22018-10-17\",\n \"Category\": \"Supplies\",\n \"Currency_Code\": \"USD\",\n \"Payment_Terms\": \"\",\n \"Account_Number\": \"\",\n \"Bill_To_Name\": \"\",\n \"Bill_To_Recipient\": \"\",\n \"Bill_To_Address\": \"\",\n \"Bill_To_Address_Line\": \"\",\n \"Bill_To_City\": \"\",\n \"Bill_To_State\": \"\",\n \"Bill_To_Zipcode\": \"\",\n \"Bill_To_Vat_Number\": \"\",\n \"Bill_To_Email\": \"\",\n \"Card_Number\": \"7373\",\n \"Payment_Display_Name\": \"Visa ***7373\",\n \"Payment_Type\": \"VISA\",\n \"Phone_Number\": \"719-471-0054\",\n \"Vat_Number\": \"\",\n \"Vendor_Name\": \"THE HOME DEPOT\",\n \"Vendor_Raw_Name\": \"THE HOME DEPOT\",\n \"Vendor_Recipient\": \"BECKY NATION\",\n \"Vendor_Email\": \"\",\n \"Vendor_Address\": \"2250 SOUTHGATE RD, COLORADO SPRINGS, CO\",\n \"Vendor_Address_Line\": \"2250 SOUTHGATE RD\",\n \"Vendor_City\": \"COLORADO SPRINGS\",\n \"Vendor_State\": \"CO\",\n \"Vendor_Zipcode\": \"\",\n \"Vendor_Country\": \"USA\",\n \"Vendor_Type\": \"\",\n \"Vendor_Phone\": \"719-471-0054\",\n \"Vendor_Fax\": \"\",\n \"Vendor_Website\": \"\",\n \"Vendor_ABN_Number\": \"\",\n \"Vendor_Bank_Name\": \"\",\n \"Vendor_Bank_Number\": \"\",\n \"Vendor_Bank_Swift\": \"\",\n \"Vendor_IBAN\": \"\",\n \"Vendor_Account_Number\": \"\",\n \"Remit_To_Name\": \"\",\n \"Remit_To_Address\": \"\",\n \"All_Email_Addresses\": \"\",\n \"Ship_To_Name\": \"\",\n \"Ship_To_Address\": \"\",\n \"Carrier\": \"\",\n \"Tracking_Number\": \"\",\n \"Pages\": 1,\n \"Is_Duplicate\": 0,\n \"Notes\": \"\",\n \"Tax_Lines\": [\n {\n \"Base\": 0,\n \"Name\": \"SALES\",\n \"Order\": 0,\n \"Rate\": 0,\n \"Total\": 2.66\n }\n ],\n \"Line_Items\": [\n {\n \"Line\": 1,\n \"SKU\": \"037103136480\",\n \"Description\": \"SNIP LEFT \\nWISS LEFT-CUT SNIPS\",\n \"Date\": \"2018-10-17\",\n \"QTY\": 1,\n \"Unit\": \"\",\n \"Order\": 0,\n \"Reference\": \"\",\n \"Tax_Rate\": 0,\n \"Tax\": 0,\n \"Type\": \"product\",\n \"Price\": 13.97,\n \"Discount\": 4,\n \"Amount\": 9.97\n },\n {\n \"Line\": 2,\n \"SKU\": \"045242268061\",\n \"Description\": \"MILW5PCKBLDG \\nMKE 5PK GENERAL PURPOSE BLADES\",\n \"Date\": \"2018-10-17\",\n \"QTY\": 1,\n \"Unit\": \"\",\n \"Order\": 1,\n \"Reference\": \"\",\n \"Tax_Rate\": 0,\n \"Tax\": 0,\n \"Type\": \"product\",\n \"Price\": 1.18,\n \"Discount\": 0,\n \"Amount\": 1.18\n },\n {\n \"Line\": 3,\n \"SKU\": \"038902058966\",\n \"Description\": \"1LB. SCREW \\nEB NEO SELF-DRILLING 12X1\",\n \"Date\": \"\",\n \"QTY\": 1,\n \"Unit\": \"\",\n \"Order\": 2,\n \"Reference\": \"\",\n \"Tax_Rate\": 0,\n \"Tax\": 0,\n \"Type\": \"product\",\n \"Price\": 10.57,\n \"Discount\": 0,\n \"Amount\": 10.57\n },\n {\n \"Line\": 4,\n \"SKU\": \"038902058959\",\n \"Description\": \"1LB. SCREW \\nEB NEO SELF-DRILLING 12X3/4\",\n \"Date\": \"\",\n \"QTY\": 1,\n \"Unit\": \"\",\n \"Order\": 3,\n \"Reference\": \"\",\n \"Tax_Rate\": 0,\n \"Tax\": 0,\n \"Type\": \"product\",\n \"Price\": 10.57,\n \"Discount\": 0,\n \"Amount\": 10.57\n }\n ],\n \"Raw_Text\": \"THE\\n\\tMore saving.\\n® More doing.\\\"\\n\\tSM\\n2250 SOUTHGATE RD, COLORADO SPRINGS, CO\\nBECKY NATION STOREMANAGER 719-471-0054\\n1518 00000 17717 10/17/18 09:03 AM\\nSELF CHECK OUT\\n037103136480 SNIP LEFT \\t9.97\\nWISS LEFT-CUT SNIPS\\nNLP Savings $4.00\\n045242268061 MILW5PCKBLDG \\t1.18\\nMKE 5PK GENERAL PURPOSE BLADES\\n038902058966 1LB. SCREW \\t10.57\\nEB NEO SELF-DRILLING 12X1\\n038902058959 1LB. SCREW \\t10.57\\nEB NEO SELF-DRILLING 12X3/4\\nSUBTOTAL\\t32.29\\nSALES TAX\\t2.66\\nTOTAL\\t$34.95\\nXXXXXXXXXXXX7373 VISA\\n\\tUSD$ 34.95\\nAUTH CODE 025972/8585391\\tTA\\nAID A0000003131010 43415050544140204F4\\nE452050595341\\nHOME\\nDEPOT\",\n \"Reference_Number\": \"\",\n \"Fraud_Score\": 5,\n \"Risk_Score\": 2,\n \"Anomaly_Score\": 5,\n \"photon_key\": \"\"\n },\n \"message\": \"success\",\n \"status\": \"success\"\n}"}],"_postman_id":"df31b744-7c62-4b66-8929-7e707c981b73"}],"id":"01251d2b-e37c-4778-b020-6c8b443fe08d","description":"To enable users to test our API without having to sign up for credentials, here are the sample documents and document-specific credentials.
\nYour email address
\n","type":"text"},{"key":"password","value":"Passit123@","description":"Passwords must be at least 10 characters\nlong, must contain at least 1 digit and 1 special character.
\n","type":"text"}]},"url":"https://sandbox-api.photoncommerce.com/api/v4/register","description":"Register a new free account using your email address and password to receive secure credentials
\nUnique Client_ID for every user. Incorrect value will lead to an authorization error.
\n","type":"default"},{"key":"AUTHORIZATION","value":"string","description":"In the format apikey your_username:your_api_key
\n","type":"default"},{"key":"PASSWORD","value":"string","description":"The password of the account
\n","type":"default"},{"key":"SECRET-KEY","value":"string","description":"The secret key of the account
\n","type":"default"}],"body":{"mode":"raw","raw":""},"url":"https://sandbox-api.photoncommerce.com/api/pro?url=string&webhook_url=string&auth_token=string&doctype=string&ID=string&subaccount=string&page_start=integer&page_end=integer","description":"Capture invoices and receipts using your Client ID, Client Secret, API Key and Username
\nTo receive notifications on your webhook URL when the document has been processed, you can pass the 'webhook_url' in your request. This parameter is optional.
\nOnce you post documents to our API, we will return a 'photon_key' in the response and begin processing your document. This photon_key can be used to fetch the json by following the steps mentioned under the section 'Retrieve Data (JSON)\" on the \"Getting Started with the Photon Commerce API\" Page. As soon as your document is processed, we will POST a request to your webhook URL to notify that the extractions are ready.
\nOur ASYNC requests are customisable to help serve our customers better. We also take in \"auth_token\" as a parameter that can be used by you to verify that the incoming notification on your webhook is from us. If you need to internally annotate a document with an ID, we will return it in our POST request to your webhook.
\n","urlObject":{"protocol":"https","path":["api","pro"],"host":["sandbox-api","photoncommerce","com"],"query":[{"disabled":true,"description":{"content":"Set to async.
\n","type":"text/plain"},"key":"type","value":"async"},{"description":{"content":"The path to the pdf, document, or image needing to be captured.
\n","type":"text/plain"},"key":"url","value":"string"},{"description":{"content":"optional. Your webhook URL where we will post notifications once the document has been processed
\n","type":"text/plain"},"key":"webhook_url","value":"string"},{"description":{"content":"optional. Auth tokens can be used to verify if the notifcation to your webhook URL is pushed by Photon.
\n","type":"text/plain"},"key":"auth_token","value":"string"},{"description":{"content":"optional. Specify the document type. Should be one of invoice, receipt, check, remittance, statement. The default is invoice.
\n","type":"text/plain"},"key":"doctype","value":"string"},{"description":{"content":"optional. Specify your document's internal ID if you need to use it to keep track of your documents internally. Once a document has been annotated, this ID will be returned in the webhook notification.
\n","type":"text/plain"},"key":"ID","value":"string"},{"description":{"content":"optional. Specify your customer's subaccount if you need to distinguish between docs from different customers.
\n","type":"text/plain"},"key":"subaccount","value":"string"},{"description":{"content":"optional. Specify the page on the document from where extractions should begin.
\n","type":"text/plain"},"key":"page_start","value":"integer"},{"description":{"content":"optional. Specify the page on the document from where extractions should end.
\n","type":"text/plain"},"key":"page_end","value":"integer"}],"variable":[]}},"response":[{"id":"0d5afd48-08b0-45b8-9a06-c94d6f00ba0e","name":"Async API - upload using URL","originalRequest":{"method":"POST","header":[{"key":"CLIENT-ID","value":"string","description":"Unique Client_ID for every user. Incorrect value will lead to an authorization error.","type":"default"},{"key":"AUTHORIZATION","value":"apikey your_username:your_api_key","description":"In the format apikey your_username:your_api_key","type":"default"},{"key":"PASSWORD","value":"string","description":"The password of the account","type":"default"},{"key":"SECRET-KEY","value":"string","description":"The secret key of the account","type":"default"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://sandbox-api.photoncommerce.com/api/pro?url=string&webhook_url=string&auth_token=string&doctype=string&ID=string&subaccount=string&page_start=integer&page_end=integer","protocol":"https","host":["sandbox-api","photoncommerce","com"],"path":["api","pro"],"query":[{"key":"type","value":"async","description":"Set to async.","disabled":true},{"key":"url","value":"string","description":"The path to the pdf, document, or image needing to be captured. "},{"key":"webhook_url","value":"string","description":"optional. Your webhook URL where we will post notifications once the document has been processed"},{"key":"auth_token","value":"string","description":"optional. Auth tokens can be used to verify if the notifcation to your webhook URL is pushed by Photon."},{"key":"doctype","value":"string","description":"optional. Specify the document type. Should be one of invoice, receipt, check, remittance, statement. The default is invoice."},{"key":"ID","value":"string","description":"optional. Alphanumeric. Specify your document's internal ID if you need to use it to keep track of your documents internally. Once a document has been annotated, this ID will be returned in the webhook notification."},{"key":"subaccount","value":"string","description":"optional. Specify your customer's subaccount if you need to distinguish between docs from different customers."},{"key":"page_start","value":"integer","description":"optional. Specify the page on the document from where extractions should begin."},{"key":"page_end","value":"integer","description":"optional. Specify the page on the document from where extractions should end."}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"photon_key\": \"your-photon-key-here\",\n \"doc_path\": \"path to the document you submitted\",\n \"message\": \"success\"\n}"}],"_postman_id":"c319d852-7dbf-4131-bc7d-54de1a12ebcf"},{"name":"Async API - upload from local","id":"9862668f-f80f-4657-9b4d-d835212a55f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"CLIENT-ID","value":"string","description":"Unique Client_ID for every user. Incorrect value will lead to an authorization error.
\n","type":"default"},{"key":"AUTHORIZATION","value":"string","description":"In the format apikey your_username:your_api_key
\n","type":"default"},{"key":"PASSWORD","value":"string","description":"The password of the account
\n","type":"default"},{"key":"SECRET-KEY","value":"string","description":"The secret key of the account
\n","type":"default"}],"body":{"mode":"formdata","formdata":[{"key":"pdf","type":"file","value":null}]},"url":"https://sandbox-api.photoncommerce.com/api/pro?webhook_url=string&auth_token=string&doctype=invoice&ID=string&subaccount=string","description":"Capture invoices and receipts using your Client ID, Client Secret, API Key and Username
\nTo receive notifications on your webhook URL when the document has been processed, you can pass the 'webhook_url' in your request. This parameter is optional.
\nOnce you post documents to our API, we will return a 'photon_key' in the response and begin processing your document. This photon_key can be used to fetch the json by following the steps mentioned under the section 'Retrieve Data (JSON)\" on the \"Getting Started with the Photon Commerce API\" Page. As soon as your document is processed, we will POST a request to your webhook URL to notify that the extractions are ready.
\nOur ASYNC requests are customisable to help serve our customers better. We also take in \"auth_token\" as a parameter that can be used by you to verify that the incoming notification on your webhook is from us. If you need to internally annotate a document with an ID, we will return it in our POST request to your webhook.
\n","urlObject":{"protocol":"https","path":["api","pro"],"host":["sandbox-api","photoncommerce","com"],"query":[{"disabled":true,"description":{"content":"Set to async.
\n","type":"text/plain"},"key":"type","value":"async"},{"description":{"content":"optional. Your webhook URL where we will post notifications once the document has been processed
\n","type":"text/plain"},"key":"webhook_url","value":"string"},{"description":{"content":"optional. Auth tokens can be used to verify if the notifcation to your webhook URL is pushed by Photon.
\n","type":"text/plain"},"key":"auth_token","value":"string"},{"description":{"content":"optional. Specify the document type. Should be one of invoice, receipt, check, remittance, statement. The default is invoice.
\n","type":"text/plain"},"key":"doctype","value":"invoice"},{"description":{"content":"optional. Alphanumeric. Specify your document's internal ID if you need to use it to keep track of your documents internally. Once a document has been annotated, this ID will be returned in the webhook notification.
\n","type":"text/plain"},"key":"ID","value":"string"},{"description":{"content":"optional. Specify your customer's subaccount if you need to distinguish between docs from different customers.
\n","type":"text/plain"},"key":"subaccount","value":"string"}],"variable":[]}},"response":[{"id":"fd49cd70-4667-4602-876c-43a1b65f6e53","name":"Async API - upload from local","originalRequest":{"method":"POST","header":[{"key":"CLIENT-ID","value":"string","description":"Unique Client_ID for every user. Incorrect value will lead to an authorization error.","type":"default"},{"key":"AUTHORIZATION","value":"apikey your_username:your_api_key","description":"In the format apikey your_username:your_api_key","type":"default"},{"key":"PASSWORD","value":"string","description":"The password of the account","type":"default"},{"key":"SECRET-KEY","value":"string","description":"The secret key of the account","type":"default"}],"body":{"mode":"formdata","formdata":[{"key":"pdf","type":"file","value":null}]},"url":{"raw":"https://sandbox-api.photoncommerce.com/api/pro?webhook_url=string&auth_token=string&doctype=invoice&ID=string&subaccount=string","protocol":"https","host":["sandbox-api","photoncommerce","com"],"path":["api","pro"],"query":[{"key":"type","value":"async","description":"Set to async.","disabled":true},{"key":"webhook_url","value":"string","description":"optional. Your webhook URL where we will post notifications once the document has been processed"},{"key":"auth_token","value":"string","description":"optional. Auth tokens can be used to verify if the notifcation to your webhook URL is pushed by Photon."},{"key":"doctype","value":"invoice","description":"optional. Specify the document type. Should be one of invoice, receipt, check, remittance, statement. The default is invoice."},{"key":"ID","value":"string","description":"optional. Alphanumeric. Specify your document's internal ID if you need to use it to keep track of your documents internally. Once a document has been annotated, this ID will be returned in the webhook notification."},{"key":"subaccount","value":"string","description":"optional. Specify your customer's subaccount if you need to distinguish between docs from different customers.","type":"text"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"photon_key\": \"your-photon-key-here\",\n \"doc_path\": \"path to the document you submitted\",\n \"message\": \"success\"\n}"}],"_postman_id":"9862668f-f80f-4657-9b4d-d835212a55f2"},{"name":"Retrieve JSON of uploaded file","id":"0cff019e-2a12-41da-947f-e2adcef1dd10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"PASSWORD","value":"string","description":"The password you used for your email registration
\n","type":"default"},{"key":"SECRET-KEY","value":"string","description":"Your secret key as a string
\n","type":"default"},{"key":"CLIENT-ID","value":"string","description":"Unique Client_ID for every user. Incorrect value will lead to an authorization error
\n","type":"default"},{"key":"AUTHORIZATION","value":"string","description":"In the format 'apikey your_username:your_api_key'
\n","type":"default"}],"url":"https://sandbox-api.photoncommerce.com/api/v4/json?photon_key=The photon_key of the uploaded file to fetch the JSON of.
\n","type":"text/plain"},"key":"photon_key","value":"In order to do asynchronous API calls, please first contact sales@photoncommerce.com to activate your account.
\nPlease provide your project requirements and samples.
\nOur standard turnaround time (TAT) for document processing is 24 hours.
We also offer expedited processing, with TATs as fast as 5 minutes.
For faster turnaround options and pricing, please contact support@photoncommerce.com.
*Mention the document type in the API request using the parameter 'doctype'. Valid options for doctype are:__*
\ninvoice
\ncheck
\nremittance
\nstatement
\nreceipt-expense
\nbol (stands for Bill of Lading)
\nhbl (stands for House Bill of Lading
\nmbl (stands for Master Bill of Lading)
\nbill-utility (Utility Bills like Electric, Gas, Water, Internet & Voice)
\nPlease note that even though passing this parameter in the API request is optional, unless the doctype is specified in the request, your document will be treated as an invoice by default.
\nFraud Score and Risk Score
\nTired of traditional document verification processes that are time-consuming, error-prone, and leave your organization vulnerable to fraudulent activities?
\nOur cutting-edge algorithms are designed to revolutionize document security by accurately detecting fraud and determining risk scores from documents in real-time. With our solution, you can streamline your verification processes, reduce manual errors, and safeguard your organization against potential threats.
\nNote: Fraud and Risk scores are optional fields. If you need to activate these for your account, please contact support@photoncommerce.com
\nTo help you better organize and differentiate between your customers, we've introduced Subaccount Support.
\nA subaccount is a unique identifier (like a customer ID) that you can pass with every API request. It helps you track usage and data on a per-customer basis — without needing to manage that separation manually.
\nCan be alphanumeric
\nCan include hyphens
\nMust be under 50 characters
\npage_start / page_end)Worried about cropping your document just to run extractions on a specific section? Does your document contain statements, BOLs, invoices, receipts, or other segments—but you only need data extracted from one of them? We've got you covered with this flexible new feature!
\nYou can now control where extractions run by specifying page_start and page_end parameters in your API request. This allows you to keep the entire document intact while targeting only a specific page range for extraction—for example, pages 2 through 7 of a 20-page document.
{\n \"page_start\": 2,\n \"page_end\": 7\n}\n\npage_start (default: 1) – The first page to include in extraction (inclusive).
page_end (default: total number of pages) – The last page to include in extraction (inclusive).
Page numbers are 1-based (i.e., the first page is 1).
Note: If either value is invalid (e.g., not an integer, out of range), it will be ignored.
\nThis feature is perfect for documents containing multiple embedded formats or sections—such as combined PDFs with invoices, receipts, and summary reports—allowing you to pinpoint exactly where extraction should occur without modifying the original file.
\nTo receive notifications on your webhook URL when the document has been processed, you can pass the 'webhook_url' in your API request.
\nOur ASYNC requests are customisable to help serve our customers better. We also take in \"auth_token\" as a parameter that can be used by you to verify that the incoming notification on your webhook is from us. If you need to internally annotate a document with an ID, we will return it in our POST request to your webhook.
\nHere's the structure of the data and header you should expect in a webhook notification from us:
\nData:
\n{'photon_key': 'your-photon-key-here', 'message': 'success', 'status': 'success'}\n\nIf you've specified an optional_id in the API request, it will be returned as 'ID' in the webhook request data.
\nHeaders:
\n{'Content-Type': 'application/json', 'Accept': 'application/json', 'Authorization': 'your-auth-token-here'}\n\nAsynchronous API for batches and queues of documents
\nNo need to wait for the results. You will be notified via webhook when the document has been processed and the result is ready to be fetched.
\nThis ASYNC API allows us to upload multiple documents, one after another with a minimal waiting time. Store the photon_key we send in the response and access it once you receive a webhook notification from Photon.
\nTo ensure the guaranteed delivery of your document data, Photon Commerce employs a robust retry mechanism for all webhook notifications.
\nA webhook delivery is considered successful only when your endpoint returns an HTTP 200 status code. Any other response (including 4xx or 5xx codes) or a connection timeout will trigger our retry sequence.
\nIf a delivery attempt fails, we will automatically retry up to 3 times using an exponential backoff strategy to account for temporary server downtime or network fluctuations:
\nFirst Attempt: Immediate notification.
\nSecond Attempt: 1 second after the first failure.
\nThird Attempt: 5 seconds after the second failure.
\nFourth Attempt: 2 minutes after the third failure.
\nIf the notification fails after the fourth and final attempt, no further retries will be performed. In such cases, you can manually retrieve the document status and structured data at any time using our FETCH JSON endpoint. We recommend implementing a reconciliation job to check this endpoint for any documents that did not result in a successful webhook confirmation.
\nset to 'application/json'
\n"},{"key":"CLIENT-ID","value":"string","type":"default","description":"Unique client-id provided during user\nregistration
\n"},{"key":"AUTHORIZATION","value":"string","type":"default","description":"In the format 'apikey your-username:your-api-key'
\n"},{"key":"PASSWORD","value":"string","type":"default","description":"Password used during user registration
\n"},{"key":"SECRET-KEY","value":"string","type":"default","description":"Your secret key as a string
\n"}],"body":{"mode":"raw","raw":"{\"Total\": 1878.8, \"Vendor_Name\": \"Einsteam\"}","options":{"raw":{"language":"text"}}},"url":"https://sandbox-api.photoncommerce.com/api/v4/update?photon_key=Update fields using a PUT request
\nYou can update any key field present in the JSON data. While submitting the data for the PUT request, make sure that the datatype of the values are preserved. The key fields, their description and datatype can be found above under the section 'Capture an invoice or receipt in real time'.
\nFor the example given, the updated JSON will have Total set as 1878.80 and Vendor_Name set as 'Einsteam'. To verify if the update worked fine, you can use the GET request mentioned above to fetch the JSON and check if the changes have been successfully applied
\n","urlObject":{"protocol":"https","path":["api","v4","update"],"host":["sandbox-api","photoncommerce","com"],"query":[{"description":{"content":"The photon key of the json file to update
\n","type":"text/plain"},"key":"photon_key","value":"Unique client-id provided during user\nregistration
\n"},{"key":"AUTHORIZATION","value":"string","type":"default","description":"In the format 'apikey your-username:your-api-key'
\n"},{"key":"SECRET-KEY","value":"string","type":"default","description":"Your secret key as a string
\n"},{"key":"PASSWORD","value":"string","type":"default","description":"Password used during user registration
\n"},{"key":"Content-Type","value":"string","type":"default","description":"Set to \"application/json\"
\n"}],"body":{"mode":"raw","raw":"{\"SKU\":\"0004\"}"},"url":"https://sandbox-api.photoncommerce.com/api/v4/update/line-items/To update an existing line item, submit a PUT request with new values in the PUT body.
\nline-item-id: the string that is the value of \"Line\" for line item to be updated.
\nLine items that can updated:
\n\"SKU\": string - parsed SKU code,\n\"Description\": string - raw item description,\n\"Date\": date of the line item as a string \"YYYY-MM-DD\",\n\"Order\": integer - Order of the item,\n\"Reference\": string - Reference ID for the item,\n\"QTY\": decimal number of units,\n\"Unit\": unit of measure,\n\"Price\": decimal unit price,\n\"Amount\": decimal total pricing,\n\"Discount\": decimal line item discount amount,\n\"Tax_Rate\": the tax rate levied,\n\"Tax\": decimal line item tax amount,\n\"Type\": inferred product or service string\n\nSet to \"application/json\"
\n"},{"key":"CLIENT-ID","value":"string","type":"default","description":"Unique client-id provided upon user \nregistration
\n"},{"key":"AUTHORIZATION","value":"string","type":"default","description":"In the format 'apikey your-username:your-api-key'
\n"},{"key":"PASSWORD","value":"string","type":"default","description":"Password used during user registration
\n"},{"key":"SECRET-KEY","value":"string","type":"default","description":"Secret key provided as a string
\n"}],"body":{"mode":"raw","raw":"{\"SKU\": \"003\", \"Description\": \"MacBook\", \"Price\": 1299, \"Amount\": 1299}"},"url":"https://sandbox-api.photoncommerce.com/api/v4/line-items?photon_key=To add a new line item, submit a POST request with the data to be updated as a string of dictionary.
\nLine Item Keys that can be added:
\n\"SKU\": string - parsed SKU code,\n\"Description\": string - raw item description,\n\"Date\": date of the line item as a string \"YYYY-MM-DD\",\n\"Order\": integer - Order of the item,\n\"Reference\": string - Reference ID for the item,\n\"QTY\": decimal number of units,\n\"Unit\": unit of measure,\n\"Price\": decimal unit price,\n\"Amount\": decimal total pricing,\n\"Discount\": decimal line item discount amount,\n\"Tax_Rate\": the tax rate levied,\n\"Tax\": decimal line item tax amount,\n\"Type\": inferred product or service string\n\nThe photon key of the json file to update
\n","type":"text/plain"},"key":"photon_key","value":"The path to the pdf, document, or image needing to be captured. Any image or Word document are also acceptable.
\n","type":"text/plain"},"key":"url","value":"Unique client-id provided upon user\nregistration
\n"},{"key":"AUTHORIZATION","value":"string","type":"default","description":"In the format 'apikey your-username:your-api-key'
\n"},{"key":"SECRET-KEY","value":"string","type":"default","description":"Secret key as a string
\n"},{"key":"PASSWORD","value":"string","type":"default","description":"Password used during user registration
\n"},{"key":"Content-Type","value":"string","type":"default","description":"Set to \"application/json\"
\n"}],"url":"https://sandbox-api.photoncommerce.com/api/v4/update/line-items/To delete an existing line item, submit a DELETE request with the corresponding line item ID.
\nThis method can be used to delete one line item at a time.
\nline-item-id: the string that is the value of \"Line\" for line item to be deleted
\n","urlObject":{"protocol":"https","path":["api","v4","update","line-items","Photon Key of the JSON file that needs to\nbe updated
\n","type":"text/plain"},"key":"photon_key","value":"To update the values extracted by Photon Commerce
\n*Note:
If you're a Sandbox user, please route all requests to sandbox-api.photoncommerce.com instead of api.photoncommerce.com
Unique client-id provided upon user\nregistration
\n"},{"key":"AUTHORIZATION","value":"string","type":"default","description":"In the format 'apikey your-username:your-api-key'
\n"},{"key":"SECRET-KEY","value":"string","type":"default","description":"Secret key as a string
\n"},{"key":"PASSWORD","value":"string","type":"default","description":"Password used during user registration
\n"}],"url":"https://sandbox-api.photoncommerce.com/download-file?doc_path=doc-path-here","urlObject":{"protocol":"https","path":["download-file"],"host":["sandbox-api","photoncommerce","com"],"query":[{"description":{"content":"This is path to the document -- returned in Photon's Response for SYNC as well as PRO requests
\n","type":"text/plain"},"key":"doc_path","value":"doc-path-here"}],"variable":[]}},"response":[],"_postman_id":"08e135e4-02cd-42e6-8bee-2ef7a0bb72c1"}],"id":"6bab6cd5-436e-4948-8cd3-4d321a6bb7ea","description":"With this feature, we give you the ability to access the original document you submitted to our API. All you need is the value of 'doc_path' from our responses and your credentials for authenticating the request.
The 'doc_path' is an indicator of where the document is stored on our system.
Your credentials serve as authentication. Nobody else except you is authorized to access and fetch files belonging to you, unless your credentials have been shared with multiple people.
\nIf a GET request is sent for a previously deleted file, we respond with the message \"File already deleted on \". This will give you an idea of the date when the file was first deleted from our system.
\n**NOTE: Calling our API endpoint to access original documents will not affect the count of your API Calls for the current term. We don't charge for this call.
\n***Note:**If you're a Sandbox user, please route all requests to sandbox-api.photoncommerce.com instead of api.photoncommerce.com
\nimport shutil\nimport requests\n\"\"\"\nFunction to send a request to Photon API to access\ncontent of original file and write the content\nto a local file.\n\"\"\"\ndef download_file(doc_path, local_path, headers):\n URL = 'https://sandbox-api.photoncommerce.com'\n URL1 = URL + f'/download-file?doc_path={doc_path}'\n response = requests.get(URL1, stream=True, headers=headers)\n print(response.raw, response.status_code)\n local_filename = local_path\n if response.status_code == 200:\n print('Writing to local file')\n print(local_filename)\n with open(local_filename, 'wb') as f:\n shutil.copyfileobj(response.raw, f)\n else:\n print(response.text)\n return response\n\nUnique client-id provided upon user\nregistration
\n"},{"key":"AUTHORIZATION","value":"string","type":"default","description":"In the format 'apikey your-username:your-api-key'
\n"},{"key":"SECRET-KEY","value":"string","type":"default","description":"Secret key as a string
\n"},{"key":"PASSWORD","value":"string","type":"default","description":"Password used during user registration
\n"},{"key":"Content-Type","value":"application/json","type":"default","description":"Set to \"application/json\"
\n"}],"url":"https://sandbox-api.photoncommerce.com/delete-file?file_key=data/dev/2022-07-07/21-52-24-080343_inv.pdf","description":"To delete an existing line item, submit a DELETE request with the corresponding line item ID.
\nThis method can be used to delete one line item at a time.
\nline-item-id: the string that is the value of \"Line\" for line item to be deleted
\n","urlObject":{"protocol":"https","path":["delete-file"],"host":["sandbox-api","photoncommerce","com"],"query":[{"description":{"content":"The file key. Can either be the value of the doc_path or photon_key in previous responses.
\n","type":"text/plain"},"key":"file_key","value":"data/dev/2022-07-07/21-52-24-080343_inv.pdf"}],"variable":[]}},"response":[{"id":"f566f13d-ecfa-4868-a56d-48c52ca5c1f0","name":"Delete Document or JSON","originalRequest":{"method":"DELETE","header":[{"key":"CLIENT-ID","value":"string","type":"default","description":"Unique client-id provided upon user\nregistration"},{"key":"AUTHORIZATION","value":"string","type":"default","description":"In the format 'apikey your-username:your-api-key'"},{"key":"SECRET-KEY","value":"string","type":"default","description":"Secret key as a string"},{"key":"PASSWORD","value":"string","type":"default","description":"Password used during user registration"},{"key":"Content-Type","value":"string","type":"default","description":"Set to \"application/json\"","disabled":true}],"url":{"raw":"https://sandbox-api.photoncommerce.com/delete-file?file_key=data/dev/2022-07-07/21-52-24-080343_inv.pdf","protocol":"https","host":["sandbox-api","photoncommerce","com"],"path":["delete-file"],"query":[{"key":"file_key","value":"data/dev/2022-07-07/21-52-24-080343_inv.pdf","description":"The file key. Can either be the value of the doc_path or photon_key in previous responses."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Thu, 28 Apr 2022 07:55:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"OPTIONS, POST, PUT, DELETE"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Sucessfully deleted file.\",\n \"status\": \"success\"\n}"}],"_postman_id":"88d9507d-60b0-4faa-9adf-994e27dd9b22"}],"id":"47776347-9a51-4733-b614-973dd40d308c","description":"With this feature, we give you the ability to delete previously uploaded files or extracted JSONs. All you need is the value of 'doc_path' , 'photon_key' from our responses and your credentials for authenticating the request.
The 'doc_path' is an indicator of where the document is stored and 'photon_key' is an indicator of where the JSON is stored.
Your credentials serve as authentication. Nobody else except you is authorized to delete files belonging to you, unless your credentials have been shared with multiple people.
\nIf a DELETE request is sent for a previously deleted file, we respond with the message \"File already deleted on \". This will give you an idea of the date when the file was first deleted from our system.
\n**NOTE: Calling our API endpoint to delete documents/JSONs will not affect the count of your API Calls for the current term. We don't charge for this call. Deleting previusly uploaded documents/JSONs will NOT decrease your upload count.
\n*Note:
If you're a Sandbox user, please route all requests to sandbox-api.photoncommerce.com instead of api.photoncommerce.com
The password you used for your email registration
\n","type":"text"},{"key":"CLIENT-ID","value":"9nHg-Ss_knhvy","description":"Unique Client_ID for every user. Incorrect value will lead to an authorization error
\n","type":"text"},{"key":"AUTHORIZATION","value":"apikey xyz@gmail.com:afh9yhJjbvSPGcPR7U-","description":"In the format 'apikey :'
\n","type":"text"},{"key":"SECRET-KEY","value":"tbWc0vgchnRw8Mvu2-u7q","description":"Your secret key as a string
\n","type":"text"}],"url":"https://sandbox-api.photoncommerce.com/api/v4?url=https://photon-api-demo.s3.us-west-1.amazonaws.com/demo_docs/00000763.tif&type=async","description":"If you contacted Photon Commerce to receive an API Key, skip the following POST request section and read on. If you registered for credentials using your email address and password, the authentication parameters in your API requests will slightly differ. The following block explains how to pass your credentials to authenticate API requests. ( Please Note: Empty and null values for all fields will appear as with 0 or empty quotations \"\", depending on if the field type is numeric or text.)
\nYou can submit files using their URL. Simply make sure that your files are publicly accessible and submit your file's URL using the optional form parameter 'url'. The proper request URL for this feature is shown below.
\nheaders= {\n # Remember to add your login credentials...\n}\nfile_url = 'https://photon-api-demo.s3.us-west-1.amazonaws.com/demo_docs/00000763.tif'\nresponse = requests.post(f'https://sandbox-api.photoncommerce.com/api/v4?url={file_url}', headers=headers)\n\nYou can scan a local file by uploading it in a POST request at the same URL.
\n # set value of variable f_name as path to local file\nf_name = 'local_file.pdf'\nfiles = {'file': open(f_name, 'rb')}\nheaders= {\n # Remember to add your login credentials...\n}\nresponse = requests.post(f'https://sandbox-api.photoncommerce.com/api/v4', headers=headers, files=files)\n\nYou can pre-specify the document type by using the doctype parameter.
\nNote: The value of this parameter should be in lowercase and must not contain any spaces. ***If any arbitrary document type is specified, Photon will re-classify the document using its own logic.
\nNote: We also parse invoices & receipts. The format/schema of the JSON response data for Checks & Remittances is different from the format/schema of the response data for other document types.
\nIf you wish to view the data only for some specific fields and not all, we can filter those out for you! All you need to do is pre-specify the fields whose extractions are important to you. Here's how: add a key 'fields' to the request data whose value is a string of comma-separated fields you're interested in. Example: If you only want to view data for 'total', 'payerName', 'checkNumber' and 'lineItems': pass \"fields\" as \"total,payerName,checkNumber, lineItems\" in the request data.
\nfile_url = 'https://photon-api-demo.s3.us-west-1.amazonaws.com/demo_docs/00000763.tif'\nheaders = {\n 'Validations': 'true',\n 'Header-Only': 'true',\n # Remember to add your login credentials...\n}\n # value for \"fields\" should be a string of only those comma separated fields whose value you want to view\n # In this example, we've set it as \"total,payerName,checkNumber, lineItems\"\ndata = {\"fields\": \"total,payerName,checkNumber,lineItems\"}\nresponse = requests.post(f'https://sandbox-api.photoncommerce.com/api/v4?url={file_url}', headers=headers, data=data)\n\nThe password you used for your email registration
\n","type":"text"},{"key":"CLIENT-ID","value":"9nHg-Ss_knhvy","description":"Unique Client_ID for every user. Incorrect value will lead to an authorization error
\n","type":"text"},{"key":"AUTHORIZATION","value":"apikey xyz@gmail.com:afh9yhJjbvSPGcPR7U-","description":"In the format 'apikey :'
\n","type":"text"},{"key":"SECRET-KEY","value":"tbWc0vgchnRw8Mvu2-u7q","description":"Your secret key as a string
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"pdf","type":"file","src":"1sykL-kb6/00000049.tif"}]},"url":"https://api.photoncommerce.com/api/v4?doctype=check&type=async","description":"If you contacted Photon Commerce to receive an API Key, skip the following POST request section and read on. If you registered for credentials using your email address and password, the authentication parameters in your API requests will slightly differ. The following block explains how to pass your credentials to authenticate API requests. ( Please Note: Empty and null values for all fields will appear as with 0 or empty quotations \"\", depending on if the field type is numeric or text.)
\nYou can submit files using their URL. Simply make sure that your files are publicly accessible and submit your file's URL using the optional form parameter 'url'. The proper request URL for this feature is shown below.
\nheaders= {\n # Remember to add your login credentials...\n}\nfile_url = 'https://photon-api-demo.s3.us-west-1.amazonaws.com/demo_docs/00-50-38-098501_00000481.pdf'\nresponse = requests.post(f'https://sandbox-api.photoncommerce.com/api/v4?url={file_url}', headers=headers)\n\nYou can scan a local file by uploading it in a POST request at the same URL.
\nf_name = 'local-file.pdf' # path to file on your device \nfiles = {'file': open(f_name, 'rb')}\nheaders= {\n # Remember to add your login credentials...\n}\nresponse = requests.post(f'https://sandbox-api.photoncommerce.com/api/v4', headers=headers, files=files)\n\nYou can pre-specify the document type by using the doctype parameter.
\nNote: The value of this parameter should be in lowercase and must not contain any spaces. ***If any arbitrary document type is specified, Photon will re-classify the document using its own logic.
\n","urlObject":{"protocol":"https","path":["api","v4"],"host":["api","photoncommerce","com"],"query":[{"key":"doctype","value":"check"},{"description":{"content":"Set to async. DO NOT CHANGE
\n","type":"text/plain"},"key":"type","value":"async"}],"variable":[]}},"response":[{"id":"a9e5df26-e7b5-43b6-a26c-347cc187a5f1","name":"Scan a Check - Local","originalRequest":{"method":"POST","header":[{"key":"PASSWORD","value":"blah","description":"The password you used for your email registration"},{"key":"CLIENT-ID","value":"9nHg-Ss_knhvy","description":"Unique Client_ID for every user. Incorrect value will lead to an authorization error"},{"key":"AUTHORIZATION","value":"apikey xyz@gmail.com:afh9yhJjbvSPGcPR7U-","description":"In the format 'apikeyThe password you used for your email registration
\n","type":"default"},{"key":"SECRET-KEY","value":"string","description":"Your secret key as a string
\n","type":"default"},{"key":"CLIENT-ID","value":"string","description":"Unique Client_ID for every user. Incorrect value will lead to an authorization error
\n","type":"default"},{"key":"AUTHORIZATION","value":"string","description":"Pass your username and unique API key in the form 'apikey :'
\n","type":"default"}],"url":"https://sandbox-api.photoncommerce.com/api/v4/json?photon_key=The photon_key of the uploaded file to fetch the JSON of.
\n","type":"text/plain"},"key":"photon_key","value":"Need accurate data from checks or remittance documents? We've got you covered.
\nOur professional human review team ensures high-accuracy extraction and verification of:
\n✔️ Remittance line items
\n✔️ Check MICR line data, LAR and CAR amounts, Signature detection
\n✔️ All other relevant check/remittance information
\nPerfect for use cases where precision matters — especially in financial workflows and audits.
\nSnippets of API calls in various languages, such as python, PHP, JAVA, C#, etc., are available upon request.
\n***Note:**If you're a Sandbox user, please route all requests to sandbox-api.photoncommerce.com instead of api.photoncommerce.com
\nThe following section explains how to pass your credentials to authenticate API requests and receive your JSON response.
\n","_postman_id":"0d5e4898-45b8-41e1-aa26-23b701fbb44f"},{"name":"8. Update Data - Checks & Remittances","item":[{"name":"Update Fields","id":"ddb7b252-b0a5-470b-8cf1-14acf568a171","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"string","type":"default","description":"set to 'application/json'
\n"},{"key":"CLIENT-ID","value":"string","type":"default","description":"Unique client-id provided during user\nregistration
\n"},{"key":"AUTHORIZATION","value":"string","type":"default","description":"In the format 'apikey your-username:your-api-key'
\n"},{"key":"PASSWORD","value":"string","type":"default","description":"Password used during user registration
\n"},{"key":"SECRET-KEY","value":"string","type":"default","description":"Your secret key as a string
\n"}],"body":{"mode":"raw","raw":"{\"total\": 1234.50, \"payerName\": \"ABC\"}","options":{"raw":{"language":"text"}}},"url":"https://sandbox-api.photoncommerce.com/api/v4/update?photon_key=data/BYPASS/2022-04-27/21-35-15-258869_00000763.json","description":"Update fields using a PUT request
\nYou can update any key field present in the JSON data. While submitting the data for the PUT request, make sure that the datatype of the values are preserved. The key fields, their description and datatype can be found in the example responses from the preceeding section 'Parse Checks & Remittances'.
\nFor the example given, the updated JSON will have total set as 1234.50 and payerName set as 'ABC'. You can use the GET request under 'Retrieve JSON of upload file' mentioned in the preceeding section to fetch the JSON and verify if the changes have been successfully applied
\n","urlObject":{"protocol":"https","path":["api","v4","update"],"host":["sandbox-api","photoncommerce","com"],"query":[{"description":{"content":"The photon key of the json file to update
\n","type":"text/plain"},"key":"photon_key","value":"data/BYPASS/2022-04-27/21-35-15-258869_00000763.json"}],"variable":[]}},"response":[{"id":"4a1db1ff-3726-4bd2-8183-da784dfabc97","name":"Update Fields","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"string","type":"default","description":"set to 'application/json'"},{"key":"CLIENT-ID","value":"string","type":"default","description":"Unique client-id provided during user\nregistration"},{"key":"AUTHORIZATION","value":"string","type":"default","description":"In the format 'apikey your-username:your-api-key'"},{"key":"PASSWORD","value":"string","type":"default","description":"Password used during user registration"},{"key":"SECRET-KEY","value":"string","type":"default","description":"Your secret key as a string"}],"body":{"mode":"raw","raw":"{\"total\": 1234.50, \"payerName\": \"ABC\"}","options":{"raw":{"language":"text"}}},"url":{"raw":"https://sandbox-api.photoncommerce.com/api/v4/update?photon_key=data/BYPASS/2022-04-27/23-37-26-612753_00000763.json","protocol":"https","host":["sandbox-api","photoncommerce","com"],"path":["api","v4","update"],"query":[{"key":"photon_key","value":"data/BYPASS/2022-04-27/23-37-26-612753_00000763.json","description":"The photon key of the json file to update"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Thu, 28 Apr 2022 06:47:11 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"PUT, OPTIONS"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Updated successfully\",\n \"status\": \"success\"\n}"}],"_postman_id":"ddb7b252-b0a5-470b-8cf1-14acf568a171"},{"name":"Update Line Items","id":"d03d7013-0a96-40de-880e-1d6d6bb4e3f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"CLIENT-ID","value":"string","type":"default","description":"Unique client-id provided during user\nregistration
\n"},{"key":"AUTHORIZATION","value":"string","type":"default","description":"In the format 'apikey your-username:your-api-key'
\n"},{"key":"SECRET-KEY","value":"string","type":"default","description":"Your secret key as a string
\n"},{"key":"PASSWORD","value":"string","type":"default","description":"Password used during user registration
\n"},{"key":"Content-Type","value":"string","type":"default","description":"Set to \"application/json\"
\n"}],"body":{"mode":"raw","raw":"{\"invoiceNumber\":\"COL / 064811\"}"},"url":"https://sandbox-api.photoncommerce.com/api/v4/update/line-items/1?photon_key=data/BYPASS/2022-04-27/21-35-15-258869_00000763.json","description":"To update an existing line item, submit a PUT request with new values in the PUT body.
\nline-item-id: the string that is the value of \"line\" for line item to be updated.
\nLine items that can updated:
\n\"invoiceNumber\": string - invoice number mentioned to refer to,\n\"description\": string - raw item description,\n\"date\": date of the line item as a string \"YYYY-MM-DD\",\n\"quantity\": decimal - number of units,\n\"unitOfMeasure\": unit of measure,\n\"purchaseOrderNumber\": string - sometimes listed under the header 'PO',\n\"referenceNumber\": string - voucher numbers, other ids for reference,\n\"taxRate\": decimal - the tax rate levied,\n\"taxAmount\": decimal - the total tax levied based on the tax rate and the amount,\n\"type\": string - inferred product or service\n\"unitPrice\": decimal - unit price,\n\"discount\": decimal - line item discount amount,\n\"amount\": decimal - total pricing\n\nIn the request example, we will be updating the invoiceNumber of the first line item. That's why the request URL has 'line-items/1'. To update the 2nd line item, it should be replaced by 'line-items/2' and so on.
\n","urlObject":{"protocol":"https","path":["api","v4","update","line-items","1"],"host":["sandbox-api","photoncommerce","com"],"query":[{"key":"photon_key","value":"data/BYPASS/2022-04-27/21-35-15-258869_00000763.json"}],"variable":[]}},"response":[{"id":"1759536c-a0a4-4ed6-8332-4e7311aebdbd","name":"Update Line Items","originalRequest":{"method":"PUT","header":[{"key":"CLIENT-ID","value":"string","type":"default","description":"Unique client-id provided during user\nregistration"},{"key":"AUTHORIZATION","value":"string","type":"default","description":"In the format 'apikey your-username:your-api-key'"},{"key":"SECRET-KEY","value":"string","type":"default","description":"Your secret key as a string"},{"key":"PASSWORD","value":"string","type":"default","description":"Password used during user registration"},{"key":"Content-Type","value":"string","type":"default","description":"Set to \"application/json\""}],"body":{"mode":"raw","raw":"{\"invoiceNumber\":\"COL / 064811\"}"},"url":{"raw":"https://sandbox-api.photoncommerce.com/api/v4/update/line-items/1?photon_key=data/BYPASS/2022-04-27/21-35-15-258869_00000763.json","protocol":"https","host":["sandbox-api","photoncommerce","com"],"path":["api","v4","update","line-items","1"],"query":[{"key":"photon_key","value":"data/BYPASS/2022-04-27/21-35-15-258869_00000763.json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Thu, 28 Apr 2022 07:07:37 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"OPTIONS, POST, PUT, DELETE"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Updated line item successfully\",\n \"status\": \"success\"\n}"}],"_postman_id":"d03d7013-0a96-40de-880e-1d6d6bb4e3f5"},{"name":"Add Line Item","id":"9c8e2a54-7a39-4b8a-adf7-5f5ca1a103b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"string","type":"default","description":"Set to \"application/json\"
\n"},{"key":"CLIENT-ID","value":"string","type":"default","description":"Unique client-id provided upon user \nregistration
\n"},{"key":"AUTHORIZATION","value":"string","type":"default","description":"In the format 'apikey your-username:your-api-key'
\n"},{"key":"PASSWORD","value":"string","type":"default","description":"Password used during user registration
\n"},{"key":"SECRET-KEY","value":"string","type":"default","description":"Secret key provided as a string
\n"}],"body":{"mode":"raw","raw":"{\"invoiceNumber\": \"Test/12\", \"description\": \"Adding a test line item\", \"unitPrice\": 1234.56, \"tax\": 5.0, \"amount\": 1239.56}"},"url":"https://sandbox-api.photoncommerce.com/api/v4/update/line-items?photon_key=data/BYPASS/2022-04-28/00-32-38-219467_00000763.json","description":"To add a new line item, submit a POST request with the data to be updated as a string of dictionary.
\nLine Item Keys that can be added:
\n\"SKU\": string - parsed SKU code,\n\"Description\": string - raw item description,\n\"Date\": date of the line item as a string \"YYYY-MM-DD\",\n\"Order\": integer - Order of the item,\n\"Reference\": string - Reference ID for the item,\n\"QTY\": decimal number of units,\n\"Unit\": unit of measure,\n\"Price\": decimal unit price,\n\"Amount\": decimal total pricing,\n\"Discount\": decimal line item discount amount,\n\"Tax_Rate\": the tax rate levied,\n\"Tax\": decimal line item tax amount,\n\"Type\": inferred product or service string\n\nThe photon key of the json file to update
\n","type":"text/plain"},"key":"photon_key","value":"data/BYPASS/2022-04-28/00-32-38-219467_00000763.json"}],"variable":[]}},"response":[{"id":"b9abd1b1-54f7-4b81-9c2c-1034a2606abb","name":"Add Line Item","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"string","type":"default","description":"Set to \"application/json\""},{"key":"CLIENT-ID","value":"string","type":"default","description":"Unique client-id provided upon user \nregistration"},{"key":"AUTHORIZATION","value":"string","type":"default","description":"In the format 'apikey your-username:your-api-key'"},{"key":"PASSWORD","value":"string","type":"default","description":"Password used during user registration"},{"key":"SECRET-KEY","value":"string","type":"default","description":"Secret key provided as a string"}],"body":{"mode":"raw","raw":"{\"invoiceNumber\": \"Test/12\", \"description\": \"Adding a test line item\", \"unitPrice\": 1234.56, \"tax\": 5.0, \"amount\": 1239.56}"},"url":{"raw":"https://sandbox-api.photoncommerce.com/api/v4/update/line-items?photon_key=data/BYPASS/2022-04-28/00-32-38-219467_00000763.json","protocol":"https","host":["sandbox-api","photoncommerce","com"],"path":["api","v4","update","line-items"],"query":[{"key":"photon_key","value":"data/BYPASS/2022-04-28/00-32-38-219467_00000763.json","description":"The photon key of the json file to update"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Thu, 28 Apr 2022 07:50:57 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"DELETE, POST, PUT, OPTIONS"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Updated line item successfully\",\n \"status\": \"success\"\n}"}],"_postman_id":"9c8e2a54-7a39-4b8a-adf7-5f5ca1a103b6"},{"name":"Delete Line Item","id":"c67c45f4-d5f2-4cea-b5e1-5e8055cfb2a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"CLIENT-ID","value":"string","type":"default","description":"Unique client-id provided upon user\nregistration
\n"},{"key":"AUTHORIZATION","value":"string","type":"default","description":"In the format 'apikey your-username:your-api-key'
\n"},{"key":"SECRET-KEY","value":"string","type":"default","description":"Secret key as a string
\n"},{"key":"PASSWORD","value":"string","type":"default","description":"Password used during user registration
\n"},{"key":"Content-Type","value":"string","type":"default","description":"Set to \"application/json\"
\n"}],"url":"https://sandbox-api.photoncommerce.com/api/v4/update/line-items/4?photon_key=data/BYPASS/2022-04-28/00-32-38-219467_00000763.json","description":"To delete an existing line item, submit a DELETE request with the corresponding line item ID.
\nThis method can be used to delete one line item at a time.
\nline-item-id: the string that is the value of \"Line\" for line item to be deleted
\n","urlObject":{"protocol":"https","path":["api","v4","update","line-items","4"],"host":["sandbox-api","photoncommerce","com"],"query":[{"description":{"content":"Photon Key of the JSON file that needs to\nbe updated
\n","type":"text/plain"},"key":"photon_key","value":"data/BYPASS/2022-04-28/00-32-38-219467_00000763.json"}],"variable":[]}},"response":[{"id":"4f2ada5b-4137-4eae-a0d1-f7a07b64169e","name":"Delete Line Item","originalRequest":{"method":"DELETE","header":[{"key":"CLIENT-ID","value":"string","type":"default","description":"Unique client-id provided upon user\nregistration"},{"key":"AUTHORIZATION","value":"string","type":"default","description":"In the format 'apikey your-username:your-api-key'"},{"key":"SECRET-KEY","value":"string","type":"default","description":"Secret key as a string"},{"key":"PASSWORD","value":"string","type":"default","description":"Password used during user registration"},{"key":"Content-Type","value":"string","type":"default","description":"Set to \"application/json\""}],"url":{"raw":"https://sandbox-api.photoncommerce.com/api/v4/update/line-items/4?photon_key=data/BYPASS/2022-04-28/00-32-38-219467_00000763.json","protocol":"https","host":["sandbox-api","photoncommerce","com"],"path":["api","v4","update","line-items","4"],"query":[{"key":"photon_key","value":"data/BYPASS/2022-04-28/00-32-38-219467_00000763.json","description":"Photon Key of the JSON file that needs to\nbe updated"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Thu, 28 Apr 2022 07:55:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"OPTIONS, POST, PUT, DELETE"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Deleted line item successfully\",\n \"status\": \"success\"\n}"}],"_postman_id":"c67c45f4-d5f2-4cea-b5e1-5e8055cfb2a4"}],"id":"03ffd2d8-6228-469f-8e1e-7bc17907f17b","description":"To update the values extracted by Photon Commerce from Checks & Remittances
\n*Note:
If you're a Sandbox user, please route all requests to sandbox-api.photoncommerce.com instead of api.photoncommerce.com
The password you used for your email registration
\n","type":"text"},{"key":"CLIENT-ID","value":"string","description":"Unique Client_ID for every user. Incorrect value will lead to an authorization error
\n","type":"text"},{"key":"AUTHORIZATION","value":"string","description":"In the format 'apikey :'
\n","type":"text"},{"key":"SECRET-KEY","value":"string","description":"Your secret key as a string
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"pdf","description":"path to local file
\n","type":"file","src":"hDN2YTn5Z/Chase_Bank_Statement1.pdf"}]},"url":"https://sandbox-api.photoncommerce.com/statements/v1?doctype=statement&type=async","description":"Bank statement parsing in seconds!
\nBy posting a PDF bank statement to our statements/v1 endpoint, you can receive a structured data response in a matter of 3-4 seconds.
\ncURL Request
\ncurl --location --request POST 'https://sandbox-api.photoncommerce.com/statements/v1' \\\n--header 'PASSWORD: Passit123@' \\\n--header 'SECRET-KEY: XTuxgZcVC5A3g2RgV7W4' \\\n--header 'AUTHORIZATION: apikey shilpasabarwal81gmail.com:5z4HZ9EVifqYUqCYRsJM' \\\n--header 'CLIENT-ID: qrAm1tjJSzof9Q' \\\n-F 'pdf=@Chase_Bank_Statement.pdf'\n\nResponse
\n{\n \"data\": {\n \"starting_balance\": 11146.68,\n \"ending_balance\": 13946.68,\n \"tot_credit\": 2802.4,\n \"tot_debit\": 2.4,\n \"statement_end_date\": \"2021-04-26\",\n \"statement_start_date\": \"2021-03-25\",\n \"account_number\": \"001100322730721\",\n \"client_name\": \"JANE DOE\",\n \"account_type\": \"Chase College Checking\",\n \"bank_name\": \"CHASE\",\n \"bank_address\": \"JPMorgan Chase Bank, N.A.\\nPO Box 182051\\nColumbus, OH 43218 - 2051\",\n \"client_address\": \"30 NEWPORT PKWY\",\n \"transactions\": [\n {\n \"date\": \"2021-04-01\",\n \"type\": \"credit\",\n \"description\": \"PPD ID: 9320517957\",\n \"amount\": 2800.0\n },\n {\n \"date\": \"2021-04-16\",\n \"type\": \"credit\",\n \"description\": \"CCD ID: 1800948598\",\n \"amount\": 1.25\n },\n {\n \"date\": \"2021-04-19\",\n \"type\": \"credit\",\n \"description\": \"CCD ID: 1800948598\",\n \"amount\": 1.15\n },\n {\n \"date\": \"2021-04-22\",\n \"type\": \"debit\",\n \"description\": \"American Express ACH Pmt M2730 Web ID: 2005134111\",\n \"amount\": 2.40\n }\n ],\n \"photon_key\": \"data/janedoe/2022-09-26/06-25-44-948850_Chase_Bank_Statement1.json\",\n \"doc_path\": \"\",\n \"hash_json\": \"data/janedoe/2022-09-26/06-25-44-948850_Chase_Bank_Statement1.json\",\n \"Is_Duplicate\": 0\n },\n \"message\": \"success\",\n \"status\": \"success\"\n}\n\ndef parse_statement(f):\n URL1 = f'https://sandbox-api.photoncommerce.com/statements/v1'\n files = {'pdf': open(f, 'rb')}\n headers = {\n 'Content-Type': 'application/json',\n 'CLIENT-ID': 'iyeHs0oJRAooRw',\n 'AUTHORIZATION': 'apikey pran.81gmail.com:e-hmk5s3qeSaWhc368pd',\n 'PASSWORD':'Passit123',\n 'SECRET-KEY':'Fie5rhNz-XnqeUiVcIr5'\n }\n r = requests.post(URL1, files=files, headers=headers)\n return r.json()\npath_to_file = 'Chase_Bank_Statement.pdf' #replace this with the local path to your own file\nr = parse_statement(path_to_file)\nprint(r)\n\nBank statement parsing in seconds!
\nBy posting a PDF bank statement to our statements/v1 endpoint, you can receive a structured data response in a matter of 3-4 seconds.
\n*Note:
If you're a Sandbox user, please route all requests to sandbox-api.photoncommerce.com instead of api.photoncommerce.com
The password you used for your email registration
\n","type":"text"},{"key":"CLIENT-ID","value":"string","description":"Unique Client_ID for every user. Incorrect value will lead to an authorization error
\n","type":"text"},{"key":"AUTHORIZATION","value":"string","description":"In the format 'apikey :'
\n","type":"text"},{"key":"SECRET-KEY","value":"string","description":"Your secret key as a string
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"pdf","description":"path to local file
\n","type":"file","src":"M9FQSZrSc/APL.pdf"}]},"url":"https://sandbox-api.photoncommerce.com/api/v4?type=async&doctype=bol","description":"Get human-reviewed data extractions from a BOL by simply posting it our API!
\ncURL Request
\ncurl --location --request POST 'https://sandbox-api.photoncommerce.com/api/v4?type=async&doctype=bol' \\\n--header 'PASSWORD: your-password' \\\n--header 'SECRET-KEY: your-secret-key' \\\n--header 'AUTHORIZATION: apikey your-username:your-api-key' \\\n--header 'CLIENT-ID: your-client-id' \\\n-F 'pdf=@BOL.pdf'\n\nResponse
\n{\n \"BOL_Number\": \"EGLV002700640670 \",\n \"Booking_Number\": \"\",\n \"Shipper\": \"TRANS WAGON INT'L CO.,LTD. \",\n \"Consignee\": \"STRAIGHT FORWARDING INC. \",\n \"Notify_Party\": \"STRAIGHT FORWARDING INC. \",\n \"Vessel\": \"EVER STEADY\",\n \"Voyage\": \"0907-066E\",\n \"Loading_Port\": \"KAOHSIUNG, TAIWAN\",\n \"Discharge_Port\": \"LOS ANGELES, CA \",\n \"Receipt_Address\": \"TAICHUNG, TAIWAN \",\n \"Delivery_Address\": \"LOS ANGELES, CA \",\n \"Marks_and_Numbers\": \"TCNU2203208\",\n \"Goods_Description\": \"THESE ARE FOR RELIGIOUS USE ONLY. THEY WILL BE USED IN THE BUDDHIST TEMPLE AND NOT FOR RESALE. RELIGIOUS RITES GOODS\\nHS CODE 3406.00\",\n \"Origin_Service_Terms\": \"O\",\n \"Destination_Service_Terms\": \"O\",\n \"Total_Quantity\": 1830,\n \"Total_Quantity_UOM\": \"PACKAGES\",\n \"Total_Measurement\": 62.18,\n \"Total_Measurement_UOM\": \"CBM\",\n \"Containers\": [\n {\n \"Container_Number\": \"TCNU2203208\",\n \"Seal_Number\": \"EMCGNE1746\",\n \"Type_and_Size\": \"40H\",\n \"Quantity\": 1830,\n \"Quantity_UOM\": \"PACKAGES\",\n \"Weight\": 24503.32,\n \"Weight_UOM\": \"KGS\",\n \"Measurement\": 62.18,\n \"Measurement_UOM\": \"CBM\"\n }\n ]\n}\n\ndef parse_bol(f):\n URL1 = f'https://sandbox-api.photoncommerce.com/api/v4?type=async&doctype=bol'\n files = {'pdf': open(f, 'rb')}\n headers = {\n 'Content-Type': 'application/json',\n 'CLIENT-ID': 'your-client-id',\n 'AUTHORIZATION': 'apikey your-username:your-api-key',\n 'PASSWORD':'your-password',\n 'SECRET-KEY':'your-secret-key'\n }\n r = requests.post(URL1, files=files, headers=headers)\n return r.json()\npath_to_file = 'BOL.pdf' #replace this with the local path to your own file\nr = parse_bol(path_to_file)\nprint(r)\n\nThe password you used for your email registration
\n","type":"default"},{"key":"SECRET-KEY","value":"string","description":"Your secret key as a string
\n","type":"default"},{"key":"CLIENT-ID","value":"string","description":"Unique Client_ID for every user. Incorrect value will lead to an authorization error
\n","type":"default"},{"key":"AUTHORIZATION","value":"string","description":"Pass your username and unique API key in the form 'apikey :'
\n","type":"default"}],"url":"https://sandbox-api.photoncommerce.com/api/v4/json?photon_key=The photon_key of the uploaded file to fetch the JSON of.
\n","type":"text/plain"},"key":"photon_key","value":"To help you standardise HBL, MBL and BOL data, Photon now extracts data for key fields from these documents!
\nAll you need to do is post a document to the /api/v4 endpoint with doctype as one of hbl, mbl or bol and leave the rest to us.
\n***Note:**If you're a Sandbox user, please route all requests to sandbox-api.photoncommerce.com **instead of api.photoncommerce.com
\nSample Extraction:**
\n{\n \"BOL_Number\": \"EGLV002700640670 \",\n \"Booking_Number\": \"\",\n \"Shipper\": \"TRANS WAGON INT'L CO.,LTD. \",\n \"Consignee\": \"STRAIGHT FORWARDING INC. \",\n \"Notify_Party\": \"STRAIGHT FORWARDING INC. \",\n \"Vessel\": \"EVER STEADY\",\n \"Voyage\": \"0907-066E\",\n \"Loading_Port\": \"KAOHSIUNG, TAIWAN\",\n \"Discharge_Port\": \"LOS ANGELES, CA \",\n \"Receipt_Address\": \"TAICHUNG, TAIWAN \",\n \"Delivery_Address\": \"LOS ANGELES, CA \",\n \"Marks_and_Numbers\": \"TCNU2203208\",\n \"Goods_Description\": \"THESE ARE FOR RELIGIOUS USE ONLY. THEY WILL BE USED IN THE BUDDHIST TEMPLE AND NOT FOR RESALE. RELIGIOUS RITES GOODS\\nHS CODE 3406.00\",\n \"Origin_Service_Terms\": \"O\",\n \"Destination_Service_Terms\": \"O\",\n \"Total_Quantity\": 1830,\n \"Total_Quantity_UOM\": \"PACKAGES\",\n \"Total_Measurement\": 62.18,\n \"Total_Measurement_UOM\": \"CBM\",\n \"Containers\": [\n {\n \"Container_Number\": \"TCNU2203208\",\n \"Seal_Number\": \"EMCGNE1746\",\n \"Type_and_Size\": \"40H\",\n \"Quantity\": 1830,\n \"Quantity_UOM\": \"PACKAGES\",\n \"Weight\": 24503.32,\n \"Weight_UOM\": \"KGS\",\n \"Measurement\": 62.18,\n \"Measurement_UOM\": \"CBM\"\n }\n ]\n}\n\nIntegrating with our API is super easy and quick—but we’ve made it even easier to extract data from your documents. With our email integration, you can simply send documents as email attachments, and we’ll take care of the rest. No setup, no coding—just results.
\nOnce your documents are processed, we’ll email back structured JSON data, along with downloadable Excel files, so you can put your data to work instantly.
\nThis is perfect for:
✅ Faster testing—quickly validate results without writing code.
✅ Non-technical teams—submit and receive data effortlessly.
✅ Flexible workflows—customize responses to fit your needs.
To activate email processing or request custom configurations, contact support@photoncommerce.com.
\nSend Documents: Attach your files and email them to our processing address.
\nFirst Response: You’ll receive a confirmation email with photon_keys, unique identifiers for each document. These can be used to retrieve results later, if needed, via our API*.
Final Response: Once all documents in the email are processed, you’ll receive:
\nOriginal documents
\nExtracted JSON data
\nXLSX files (one per document, unless customized)
\n*Note: To retrieve results via the API, you need to register for a free sandbox account using the same email that is used to send documents to us.
\nWe understand that every business has unique needs. That’s why we offer flexible response formats, including but not limited to:
\n📊 Single vs. Consolidated XLSX: Receive individual Excel files per document or a single, combined spreadsheet.
\n🛠 Custom JSON Structure: Tailor the JSON output to match your internal systems.
\nIf you need any customizations, reach out to support@photoncommerce.com for a quote.
\nEmail Attachment Limits: Individual document size cannot exceed 25MB and the total size across all attachments should be lower than 25 MB.
\nNo Live Status Updates: Unlike our API, email processing doesn’t provide real-time progress tracking.
\nNo. of Attachments: While there is no explicit limit on the no. of documents you can attach in a single email (as far as the total size is <25 MB), we recommend keeping the number of attachments in a single email below 10 to avoid delays*.
\n*Since responses are only sent after all documents in an email are processed, large batches may take longer to return results.
\nFor businesses needing faster processing, larger file support, or API-driven automation, we recommend using our asynchronous API service.
\nTo activate email submission or discuss your specific needs, contact support@photoncommerce.com today! 🚀
\n","_postman_id":"0dcae61f-eb93-4cca-8dc5-8335b5429f6a"},{"name":"12. Document Splitter","item":[{"name":"Split Document - Web URL","id":"deea7604-fd10-4996-8899-9139a0b5ce71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"CLIENT-ID","value":"clientIDHere","description":"Unique Client_ID for every user. The preset value for this header is a working test credential specially curated for this sample request.
\n","type":"default"},{"key":"AUTHORIZATION","value":"apikey usernameHere:apikeyHere","description":"In the format 'apikey :'. The preset value for this header is a working test credential specially curated for this sample request.
\n","type":"default"},{"key":"PASSWORD","value":"passwordHere","description":"The password you used for your email registration. The preset value for this header is a working test credential specially curated for this sample request.
\n","type":"default"},{"key":"SECRET-KEY","value":"secretKeyHere","description":"Your secret key as a string. The preset value for this header is a working test credential specially curated for this sample request.
\n","type":"default"}],"url":"https://sandbox-api.photoncommerce.com/docsplitter?url=https://photon-api-demo.s3.us-west-1.amazonaws.com/demo_docs/multidocument.pdf","description":"Unique Client_ID for every user. The preset value for this header is a working test credential specially curated for this sample request.
\n","type":"default"},{"key":"AUTHORIZATION","value":"apikey usernameHere:apikeyHere","description":"In the format 'apikey :'. The preset value for this header is a working test credential specially curated for this sample request.
\n","type":"default"},{"key":"PASSWORD","value":"passwordHere","description":"The password you used for your email registration. The preset value for this header is a working test credential specially curated for this sample request.
\n","type":"default"},{"key":"SECRET-KEY","value":"secretKeyHere","description":"Your secret key as a string. The preset value for this header is a working test credential specially curated for this sample request.
\n","type":"default"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"nwHLnPCR8/multidocument.pdf"}]},"url":"https://sandbox-api.photoncommerce.com/docsplitter","description":"Introducing a new feature - Document Splitter
\nDoes your document contain multiple invoices within it? Our intelligent splitter can help you by detecting the page boundaries and tell you where exactly an invoice ends and another one begins! With our detected page boundaries and a few lines of code, you can easily separate out individual invoices from your document.
\nNot sure whether your document contains a single invoice or multiple ones? Try our API and let us help you!
\n*Note:
If you're a Sandbox user, please route all requests to sandbox-api.photoncommerce.com instead of api.photoncommerce.com
Unique Client_ID for every user. The preset value for this header is a working test credential specially curated for this sample request.
\n","type":"default"},{"key":"AUTHORIZATION","value":"apikey usernameHere:apikeyHere","description":"In the format 'apikey :'. The preset value for this header is a working test credential specially curated for this sample request.
\n","type":"default"},{"key":"PASSWORD","value":"passwordHere","description":"The password you used for your email registration. The preset value for this header is a working test credential specially curated for this sample request.
\n","type":"default"},{"key":"SECRET-KEY","value":"secretKeyHere","description":"Your secret key as a string. The preset value for this header is a working test credential specially curated for this sample request.
\n","type":"default"}],"url":"https://sandbox-api.photoncommerce.com/classify?url=https://photon-api-demo.s3.us-west-1.amazonaws.com/demo_docs/Chase-Bank-Statement-BankStatements.net_.pdf","description":"Unique Client_ID for every user. The preset value for this header is a working test credential specially curated for this sample request.
\n","type":"default"},{"key":"AUTHORIZATION","value":"apikey usernameHere:apikeyHere","description":"In the format 'apikey :'. The preset value for this header is a working test credential specially curated for this sample request.
\n","type":"default"},{"key":"PASSWORD","value":"passwordHere","description":"The password you used for your email registration. The preset value for this header is a working test credential specially curated for this sample request.
\n","type":"default"},{"key":"SECRET-KEY","value":"secretKeyHere","description":"Your secret key as a string. The preset value for this header is a working test credential specially curated for this sample request.
\n","type":"default"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["nwHLnPCR8/multidocument.pdf"],"src":"lea6YGdcZ/Chase-Bank-Statement-BankStatements.net_.pdf"}]},"url":"https://sandbox-api.photoncommerce.com/classify","description":"Introducing a new feature - Document Type Detector
\nHave multiple documents and are finding manual document classification time consuming? Our intelligent document type detector can help you by detecting the document type based on the document text, dimensions and other aspects ! Now, you can easily route documents to our PRO API with this detected document type and have 99.9% accurate data extracted within minutes!
\nNot sure whether your document classifies as a commercial invoice or BOL? Try our API and let us help you!
\nOur algorithms can currently detect the following document types:
\ninvoice
\nreceipt
\nbill-utility: Utility Bill
\nremittance
\ncheck
\nstatement: Bank Statement
\nbol: Bill of Lading
\ninvoice-commercial: Commercial Invoice
\n***Note:**If you're a Sandbox user, please route all requests to sandbox-api.photoncommerce.com instead of api.photoncommerce.com
\n","_postman_id":"9cb7f63a-28ee-44f1-ac7a-ff1417c23798"},{"name":"14. Rotate Keys","item":[{"name":"Rotate keys","id":"867a8e1d-7c01-40d5-adee-56114fb3a6d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"email","value":"your-email-here","description":"The email associated with your account
\n","type":"text"}]},"url":"https://sandbox-api.photoncommerce.com/rotate-keys","description":"Make sure that the email address passed in the request is the one you used to register an account with us.
\nThe response {\"message\": \"An email has been sent to your registered email address. Please check your inbox and verify your email address\", \"status\": \"successful\"} suggests that the request went through correctly.
\nIn case you receive a different response from the one mentioned above, the \"message\" in the response will be indicative of the exact error in your request.
\n","urlObject":{"protocol":"https","path":["rotate-keys"],"host":["sandbox-api","photoncommerce","com"],"query":[],"variable":[]}},"response":[{"id":"019c1283-2217-4833-9ddb-aa9b30c59a09","name":"Rotate keys","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"email","value":"your-email-here","description":"The email associated with your account","type":"text"}]},"url":"https://sandbox-api.photoncommerce.com/rotate-keys"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"An email has been sent to your registered email address. Please check your inbox and verify your email address\",\n \"status\": \"successful\"\n}"}],"_postman_id":"867a8e1d-7c01-40d5-adee-56114fb3a6d5"}],"id":"82afeaa9-c8cd-45f3-907c-0cd82662d7e2","description":"Don't have access to your credentials? Want to rotate your credentials for securtiy purposes?
\nWe hear you! Introducing the 'Rotate keys' feature. Simply POST a request to the 'rotate-keys' endpoint with your username in the request. You will receive an email with a link to verify and confirm that it is indeed you that submitted a request to rotate the keys. Do NOT share this link with anyone. Once you click on the link, the rotated keys will be displayed and an email containing the updated credentials will also be sent to you.
\n*Note:
If you're a Sandbox user, please route all requests to sandbox-api.photoncommerce.com instead of api.photoncommerce.com
Unique Client_ID for every user. The preset value for this header is a working test credential specially curated for this sample request.
\n","type":"default"},{"key":"AUTHORIZATION","value":"string","description":"In the format 'apikey :'. The preset value for this header is a working test credential specially curated for this sample request.
\n","type":"default"},{"key":"PASSWORD","value":"string","description":"The password you used for your email registration. The preset value for this header is a working test credential specially curated for this sample request.
\n","type":"default"},{"key":"SECRET-KEY","value":"string","description":"Your secret key as a string. The preset value for this header is a working test credential specially curated for this sample request.
\n","type":"default"}],"url":"https://sandbox-api.photoncommerce.com/balance?year=2023&month=1","description":"Example request in Python:
\nimport requests\nurl = \"https://sandbox-api.photoncommerce.com/balance?year=2023&month=1\"\npayload = {}\nheaders = {\n 'CLIENT-ID': 'string',\n 'AUTHORIZATION': 'string',\n 'PASSWORD': 'string',\n 'SECRET-KEY': 'string'\n}\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\nprint(response.text)\n\nOptional field: 4 digit year. If not mentioned, the default value will be the current year
\n","type":"text/plain"},"key":"year","value":"2023"},{"description":{"content":"Optional field: month number. If not mentioned, the default value will be the current month
\n","type":"text/plain"},"key":"month","value":"1"}],"variable":[]}},"response":[{"id":"d72897d5-2396-476d-8512-08bec7b03d10","name":"Fetch API Calls and Pages","originalRequest":{"method":"POST","header":[{"key":"CLIENT-ID","value":"string","description":"Unique Client_ID for every user. The preset value for this header is a working test credential specially curated for this sample request.","type":"default"},{"key":"AUTHORIZATION","value":"string","description":"In the format 'apikeyUnique Client_ID for every user. The preset value for this header is a working test credential specially curated for this sample request.
\n","type":"default"},{"key":"AUTHORIZATION","value":"string","description":"In the format 'apikey :'. The preset value for this header is a working test credential specially curated for this sample request.
\n","type":"default"},{"key":"PASSWORD","value":"string","description":"The password you used for your email registration. The preset value for this header is a working test credential specially curated for this sample request.
\n","type":"default"},{"key":"SECRET-KEY","value":"string","description":"Your secret key as a string. The preset value for this header is a working test credential specially curated for this sample request.
\n","type":"default"}],"url":"https://sandbox-api.photoncommerce.com/balance?year=2023&subaccount=True","description":"Example request in Python:
\nimport requests\nurl = \"https://sandbox-api.photoncommerce.com/balance?subaccount=True&year=2023&month=1\"\npayload = {}\nheaders = {\n 'CLIENT-ID': 'string',\n 'AUTHORIZATION': 'string',\n 'PASSWORD': 'string',\n 'SECRET-KEY': 'string'\n}\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\nprint(response.text)\n\nOptional field: 4 digit year. If not mentioned, the default value will be the current year
\n","type":"text/plain"},"key":"year","value":"2023"},{"description":{"content":"set to True; don't change
\n","type":"text/plain"},"key":"subaccount","value":"True"}],"variable":[]}},"response":[{"id":"3f88fe05-4a9c-4d14-8385-db8b73a116df","name":"An Invoice Request","originalRequest":{"method":"POST","header":[{"key":"CLIENT-ID","value":"string","type":"default"},{"key":"AUTHORIZATION","value":"string","type":"default"},{"key":"PASSWORD","value":"string","type":"default"},{"key":"SECRET-KEY","value":"string","type":"default"}],"url":{"raw":"https://sandbox-api.photoncommerce.com/balance?subaccount=True&year=2023&month=1","protocol":"https","host":["sandbox-api","photoncommerce","com"],"path":["balance"],"query":[{"key":"subaccount","value":"True","description":"set to True; don't change"},{"key":"year","value":"2023","description":"Optional field: 4 digit year. If not mentioned, the default value will be the current year"},{"key":"month","value":"1","description":"Optional field: month number. If not mentioned, the default value will be the current month"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Sun, 09 Jan 2022 14:38:48 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"user\": \"testcustomer12\",\n \"api_calls\": 2,\n \"pages\": 2\n },\n {\n \"user\": \"niralis\",\n \"api_calls\": 1,\n \"pages\": 1\n }\n ],\n \"message\": \"success\",\n \"status\": \"success\"\n}"}],"_postman_id":"8e19187d-3116-4f8f-b812-84c436c17a5c"}],"id":"2744ae63-ee60-4676-a226-bc36c345bd39","description":"Want to keep track of the number of API calls and document pages submitted to our API? We hear you!
\nBy submitting a GET request to the '/balance' endpoint, you can learn about the number of documents and document pages we've processed for your account in the current month.
\nHave you been using our 'subaccount' feature and wish to fetch the balances per subaccount? All you need to do is pass 'subaccount' as True in the request, and we'll handle the rest!
\n***Note:**If you're a Sandbox user, please route all requests to sandbox-api.photoncommerce.com instead of api.photoncommerce.com
\n","_postman_id":"2744ae63-ee60-4676-a226-bc36c345bd39"},{"name":"16. Server Health Check","item":[{"name":"Health API request","event":[{"listen":"test","script":{"id":"93e9eb82-2439-4092-9d7d-ffde88ba1d56","exec":["pm.test(\"Status code is 200\", function (){"," pm.response.to.have.status(200);","})","pm.test(\"Response time is less than 200ms\", function(){"," pm.expect(pm.response.responseTime).to.be.below(200);","})"],"type":"text/javascript"}}],"id":"5975899a-62a7-4c12-a06b-9965eda0eaa1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://sandbox-api.photoncommerce.com/health","description":"Check the status of the server with this simple GET request.
\n","urlObject":{"protocol":"http","path":["health"],"host":["sandbox-api","photoncommerce","com"],"query":[],"variable":[]}},"response":[{"id":"71bc9460-2d41-49ed-81fe-cdc40010d5c7","name":"Health API request","originalRequest":{"method":"GET","header":[],"url":"http://sandbox-api.photoncommerce.com/health"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"healthy\",\n \"status\": \"success\"\n}"}],"_postman_id":"5975899a-62a7-4c12-a06b-9965eda0eaa1"}],"id":"7f5aeaef-cb33-4ba8-bde9-26ca886d9362","description":"*Note:
If you're a Sandbox user, please route all requests to sandbox-api.photoncommerce.com instead of api.photoncommerce.com
Generally, if the document submitted by the user is processed, the \"message\" in the response is \"success\". However, there can be a lot of reasons behind why a request could not be successfully completed. To help users understand these reasons better, Photon returns custom error messages.
\nBelow is the list of all possible error messages that our API service can return within the \"message\" key and the reason for the same.
\n","_postman_id":"323bd673-7e35-46eb-92de-f81bdc96521e"},{"name":"18. Limits","item":[],"id":"1ce18560-a7db-4deb-8305-79854724895c","description":"Photon Commerce API is easy to use, has a lot of features and provides structured responses with 99%+ accuracy. But there are some limitations.
\nSandbox account
\nThe free trial includes 20 API Calls over 14 days. To continue using our services, please upgrade your account for more API calls & pages by contacting sales@photoncommerce.com.
\nFile Types
\nWe support the following file types:
\nPDF - regular as well as scanned PDFs, single as well as multipage
\nImages - .png, .jpeg, .jpg, .tif, .tiff, .heic
\nDoc - .doc, .docx
\nExcel - .xls, .xlsx
\nHTML - .html
\nText - .txt
\nFile Size
We only process documents between 1KB and 50MB in size. For files lesser than 1KB and greater than 50MB in size, we return a 400 Bad Request response.
API Calls Rate
Our API call rate is set to 10 requests per second. As an example, if a user submits 11 requests to our API within a second, we set the first 10 requests for processing. Only when one of these requests has been processed, the 11th request is set for processing.