{"note":"OpenAPI conversion -- returning structured metadata","name":"taggun-io","description":"TAGGUN Receipt OCR Scanning API","version":"1.16.102","base_url":"https://api.taggun.io/","endpoints":23,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api TAGGUN Receipt OCR Scanning API\n@base https://api.taggun.io/\n@version 1.16.102\n@auth ApiKey apikey in header\n@common_fields {apikey: any # API authentication key.}\n@endpoints 23\n@hint download_for_search\n@toc api(23)\n\n@endpoint GET /api/account/v1/known-merchants/export\n@desc Export a list of merchant names and addresses to normalise and match in CSV format\n@errors {400: Bad Request}\n\n@endpoint GET /api/account/v1/known-product-codes/export\n@desc Export a list of product codes to normalise and match in CSV format\n@errors {400: Bad Request}\n\n@endpoint GET /api/account/v1/product-categories/export\n@desc Export a list of product categories and descriptions to match in CSV format\n@errors {400: Bad Request}\n\n@endpoint GET /api/validation/v1/campaign/settings/list\n@desc list all campaign setting IDs for a client\n@errors {400: Bad Request}\n\n@endpoint GET /api/validation/v1/campaign/settings/{campaignId}\n@desc get campaign settings for a client\n@required {campaignId: any # The ID of the campaign to validate the receipt}\n@errors {400: Bad Request}\n\n@endpoint POST /api/account/v1/feedback\n@desc Add manually verified receipt data to a given receipt for feedback and training purposes\n@optional {body: map}\n@returns(200) Success\n@errors {400: Bad Request}\n\n@endpoint POST /api/account/v1/known-merchants/import\n@desc Import a list of merchant names and addresses to normalise and match in CSV to TSV format.\n@optional {file: any # file less than 20MB. Accepted file types: CSV, TSV}\n@returns(200) Success\n@errors {400: Bad Request}\n\n@endpoint POST /api/account/v1/known-product-codes/import\n@desc Import a list of product codes to normalise in and match in CSV to TSV format.\n@optional {file: any # file less than 20MB. Accepted file types: CSV, TSV}\n@returns(200) Success\n@errors {400: Bad Request}\n\n@endpoint POST /api/account/v1/merchantname/add\n@desc Add a keyword to your account's model to predict merchant name. Changes in your account's model are updated daily.\n@optional {body: map}\n@returns(200) Success\n@errors {400: Bad Request}\n\n@endpoint POST /api/account/v1/product-categories/import\n@desc Import a list of product categories and descriptions to match in CSV to TSV format.\n@optional {file: any # file less than 20MB. Accepted file types: CSV, TSV}\n@returns(200) Success\n@errors {400: Bad Request}\n\n@endpoint POST /api/receipt/v1/simple/encoded\n@desc transcribe a receipt using base64 encoded image in json payload\n@optional {body: map}\n@returns(200) Success\n@errors {400: Bad Request}\n\n@endpoint POST /api/receipt/v1/simple/file\n@desc transcribe a receipt by uploading an image file\n@optional {file: any # file less than 20MB. Accepted file types: PDF, JPG, PNG, GIF, HEIC, refresh: any # Set true to force re-process image transcription if the receipt is already in storage, incognito: any # Set true to avoid saving the receipt in storage, ipAddress: any # IP Address of the end user, near: any # A geo location to search for merchant. Typically in the format of city, state, country., ignoreMerchantName: any # Ignore this merchant name if detected on the receipt. Use this field to avoid detecting the customer name as the merchant name., language: any # Set language as a hint. Leave empty for auto detect. Supported languages: , en, es, fr, jp, he, iw, et, lv, lt, fi, el, zh, th, ar, extractTime: any # Set true to return time if found on the receipt. Otherwise, the time is always set to 12:00:00.000., subAccountId: any # Tag a request with sub-account ID for billing purposes, referenceId: any # Tag a request with a unique reference ID for feedback/training and receipt similarity check purposes, userId: any # Tag a request with a user ID so that duplicate receipts by the same user can be detected, containerId: any # Tag a request with a container ID for fraud detection purposes}\n@returns(200) Success\n@errors {400: Bad Request}\n\n@endpoint POST /api/receipt/v1/simple/url\n@desc transcribe a receipt from URL\n@optional {body: map}\n@returns(200) Success\n@errors {400: Bad Request}\n\n@endpoint POST /api/receipt/v1/verbose/encoded\n@desc transcribe a receipt using base64 encoded image in json payload and return detailed result\n@optional {body: map}\n@returns(200) Success\n@errors {400: Bad Request}\n\n@endpoint POST /api/receipt/v1/verbose/file\n@desc transcribe a receipt by uploading an image file and return detailed result\n@optional {file: any # file less than 20MB. Accepted file types: PDF, JPG, PNG, GIF, HEIC, refresh: any # Set true to force re-process image transcription if the receipt is already in storage, incognito: any # Set true to avoid saving the receipt in storage, ipAddress: any # IP Address of the end user, near: any # A geo location to search for merchant. Typically in the format of city, state, country., ignoreMerchantName: any # Ignore this merchant name if detected on the receipt. Use this field to avoid detecting the customer name as the merchant name., language: any # Set language as a hint. Leave empty for auto detect. Supported languages: , en, es, fr, jp, he, iw, et, lv, lt, fi, el, zh, th, ar, extractTime: any # Set true to return time if found on the receipt. Otherwise, the time is always set to 12:00:00.000., subAccountId: any # Tag a request with sub-account ID for billing purposes, referenceId: any # Tag a request with a unique reference ID for feedback/training and receipt similarity check purposes, userId: any # Tag a request with a user ID so that duplicate receipts by the same user can be detected, containerId: any # Tag a request with a container ID for fraud detection purposes, extractLineItems: any # Set true to return product line itmes in an array if found on the receipt.}\n@returns(200) Success\n@errors {400: Bad Request}\n\n@endpoint POST /api/receipt/v1/verbose/url\n@desc transcribe a receipt from URL and return detailed result\n@optional {body: map}\n@returns(200) Success\n@errors {400: Bad Request}\n\n@endpoint POST /api/validation/v1/campaign/file\n@desc validate and match a receipt against a receipt validation settings by uploading an image file\n@required {campaignId: any # The ID of the campaign to validate the receipt}\n@optional {file: any # file less than 20MB. Accepted file types: PDF, JPG, PNG, GIF, HEIC, incognito: any # Set true to avoid saving the receipt in storage, ipAddress: any # IP Address of the end user, near: any # A geo location to search for merchant. Typically in the format of city, state, country., referenceId: any # Tag a request with a unique reference ID for feedback/training and receipt similarity check purposes, userId: any # Tag a request with a user ID so that duplicate receipts by the same user can be detected, subAccountId: any # Tag a request with a subAccountId, language: any # Set language as a hint. Leave empty for auto detect. Supported languages: , en, es, fr, jp, he, iw, et, lv, lt, fi, el, zh, th, ar}\n@returns(200) Success\n@errors {400: Bad Request}\n\n@endpoint POST /api/validation/v1/campaign/product-validation/file\n@desc validate if user-submitted info like serial number are detected an image file\n@required {productVerificationNumber: any # The number of the product to validate the receipt}\n@optional {file: any # file less than 20MB. Accepted file types: PDF, JPG, PNG, GIF, HEIC, incognito: any # Set true to avoid saving the receipt in storage, subAccountId: any # Tag a request with sub-account ID for billing purposes, referenceId: any # Tag a request with a unique reference ID for feedback and training purposes}\n@returns(200) Success\n@errors {400: Bad Request}\n\n@endpoint POST /api/validation/v1/campaign/receipt-validation/file\n@desc validate and match a receipt against a receipt validation settings by uploading an image file\n@required {campaignId: any # The ID of the campaign to validate the receipt}\n@optional {file: any # file less than 20MB. Accepted file types: PDF, JPG, PNG, GIF, HEIC, incognito: any # Set true to avoid saving the receipt in storage, ipAddress: any # IP Address of the end user, near: any # A geo location to search for merchant. Typically in the format of city, state, country., referenceId: any # Tag a request with a unique reference ID for feedback/training and receipt similarity check purposes, userId: any # Tag a request with a user ID so that duplicate receipts by the same user can be detected, subAccountId: any # Tag a request with a subAccountId, language: any # Set language as a hint. Leave empty for auto detect. Supported languages: , en, es, fr, jp, he, iw, et, lv, lt, fi, el, zh, th, ar}\n@returns(200) Success\n@errors {400: Bad Request}\n\n@endpoint POST /api/validation/v1/campaign/receipt-validation/url\n@desc validate and match a receipt against a receipt validation settings from URL\n@optional {body: map}\n@returns(200) Success\n@errors {400: Bad Request}\n\n@endpoint POST /api/validation/v1/campaign/settings/create/{campaignId}\n@desc create campaign settings for a client\n@required {campaignId: any # The ID of the campaign to validate the receipt}\n@optional {body: map}\n@errors {400: Bad Request}\n\n@endpoint PUT /api/validation/v1/campaign/settings/update/{campaignId}\n@desc update campaign settings for a client\n@required {campaignId: any # The ID of the campaign to validate the receipt}\n@optional {body: map}\n@errors {400: Bad Request}\n\n@endpoint DELETE /api/validation/v1/campaign/settings/delete/{campaignId}\n@desc delete campaign settings for a client\n@required {campaignId: any # Remove campaign settings with a campaign ID}\n@errors {400: Bad Request}\n\n@end\n"}