Overview

This API endpoint checks if the receipt upload feature is enabled for the Magic Receipts program and retrieves the configuration settings related to the receipt upload process.

HTTP Request

curl \
-X GET https://receipts.bitlabs.ai/?cmd=mp-mr-api-receipt-upload-enabled \
-H "Authorization: Bearer <token>"

Response Object

Name	Type	Description
`maxManualReviewForUpload`	integer	The maximum number of manual reviews that can be requested per receipt upload. This is also internal and likely won’t be used.
`maxOfferUploads`	integer	The maximum number of offers that can be uploaded at one time.
`dataShareOptInBonusAmount`	integer	The bonus amount awarded for opting into data sharing during the receipt upload process. This is internal and likely won’t be used.
`enabled`	boolean	Indicates whether the receipt upload feature is currently enabled.

Example Response

{  
   "maxManualReviewForUpload":10,  
   "maxOfferUploads":10,  
   "dataShareOptInBonusAmount":10,  
   "enabled":true  
}

Description

The response provides the client with essential configuration settings that govern the receipt upload process:

maxManualReviewForUpload: Clients can use this value to inform users how many items on their receipt can be reviewed manually if automatic processing does not recognize them.
maxOfferUploads: This value can be used to validate the number of offers a user is attempting to upload and to enforce limits within the client application.
dataShareOptInBonusAmount: If there is a bonus associated with opting into data sharing, this value can be displayed to the user as an incentive.
enabled: The client application can use this boolean flag to enable or disable the receipt upload functionality dynamically, without requiring an update or release.

Notes

This endpoint should be called before attempting to upload a receipt to ensure the feature is available and to retrieve the current operational parameters.
The provided settings should be used to set up client-side validations and to inform the user of the receipt upload process's rules and potential benefits.
You can attach custom parameters to the upload request. Learn about it here.