Enumerations

BRAccountLinkingError

Error codes returned by account linking operations.

typedef NS_ENUM(NSUInteger, BRAccountLinkingError) { ... };

enum BRAccountLinkingError : UInt

SDK Version: 3.2.0

Cases

Value	Objective-C Name	Swift Name	Description
0	BRAccountLinkingErrorNone	none	No error
1	BRAccountLinkingErrorNoAccountsLinked	noAccountsLinked	An attempt was made to grab orders for all merchants or for a specific merchant, but no merchant accounts had been linked
2	BRAccountLinkingErrorAccountLinkedAlready	accountLinkedAlready	An attempt was made to link a merchant, but the same had been linked already
3	BRAccountLinkingErrorVerificationNeeded	verificationNeeded	Login encountered a scenario requiring manual user intervention (CAPTCHA, 2FA, etc)
4	BRAccountLinkingErrorVerificationCompleted	verificationCompleted	The user successfully completed the authentication manually
5	BRAccountLinkingErrorVerificationCancelled	verificationCancelled	The user cancelled the manual authentication
6	BRAccountLinkingErrorNoCredentials	noCredentials	An attempt was made to grab orders from Amazon (legacy parser) but no Amazon credentials were found
7	BRAccountLinkingErrorInternal	internal	An unexpected error occurred during login or parsing
8	BRAccountLinkingErrorParsingFail	parsingFail	The structure of the merchant's website or data feed was unexpected
9	BRAccountLinkingErrorInvalidCredentials	invalidCredentials	Login failed on the merchant's site due to invalid credentials
10	BRAccountLinkingErrorRetailerNotFound	retailerNotFound	An attempt was made to grab orders for a particular merchant but no linked account for that merchant was found
11	BRAccountLinkingErrorInvalidKey	invalidKey	Invalid license or prodIntel key. Contact blinkreceipt@microblink.com to validate your key(s).
12	BRAccountLinkingErrorCancelled	cancelled	The operation was cancelled
13	BRAccountLinkingErrorFeatureNotAvailable	featureNotAvailable	The feature is not available on your device
14	BRAccountLinkingErrorAuthenticationFail	authenticationFail	Login failed on the merchant's site
15	BRAccountLinkingErrorWebViewClosed	webViewClosed	Authentication failed due to WebView being terminated by user
16	BRAccountLinkingErrorUnsupportedRetailer	unsupportedRetailer	This retailer is not currently supported
17	BRAccountLinkingErrorSystemTerminated	systemTerminated	The operating system terminated the operation due to not enough time for the app to run in background

---

BRAccountLinkingRetailer

Identifiers for supported retail merchants used in account linking.

typedef NS_ENUM(NSUInteger, BRAccountLinkingRetailer) { ... };

enum BRAccountLinkingRetailer : UInt

SDK Version: 3.2.0

Cases

Value	Name
1	BRAccountLinkingRetailerTarget
2	BRAccountLinkingRetailerCostco
3	BRAccountLinkingRetailerCVS
4	BRAccountLinkingRetailerDollarGeneral
5	BRAccountLinkingRetailerDollarTree
6	BRAccountLinkingRetailerKroger
7	BRAccountLinkingRetailerPublix
8	BRAccountLinkingRetailerSafeway
9	BRAccountLinkingRetailerSamsClub
10	BRAccountLinkingRetailerWalgreens
11	BRAccountLinkingRetailerWalmart
15	BRAccountLinkingRetailerHomeDepot
16	BRAccountLinkingRetailerLowes
17	BRAccountLinkingRetailerAcmeMarkets
19	BRAccountLinkingRetailerMeijer
20	BRAccountLinkingRetailerAlbertsons
22	BRAccountLinkingRetailerShoprite
23	BRAccountLinkingRetailerJewelOsco
31	BRAccountLinkingRetailerFood4Less
33	BRAccountLinkingRetailerHarrisTeeter
40	BRAccountLinkingRetailerRalphs
45	BRAccountLinkingRetailerBJs
52	BRAccountLinkingRetailerWegmans
53	BRAccountLinkingRetailerFredMeyer
54	BRAccountLinkingRetailerSprouts
63	BRAccountLinkingRetailerVons
171	BRAccountLinkingRetailerSephora
177	BRAccountLinkingRetailerBestBuy
5718	BRAccountLinkingRetailerCostcoCA
5849	BRAccountLinkingRetailerWalmartCA
6036	BRAccountLinkingRetailerAsdaUK
6048	BRAccountLinkingRetailerSainsburyUK
6051	BRAccountLinkingRetailerTescoUK
6059	BRAccountLinkingRetailerCarrefourES
6162	BRAccountLinkingRetailerDicksSportingGoods
6457	BRAccountLinkingRetailerGap
6677	BRAccountLinkingRetailerStarbucks
7610	BRAccountLinkingRetailerColesAU
8366	BRAccountLinkingRetailerDominosPizza
8643	BRAccountLinkingRetailerAmazon
8646	BRAccountLinkingRetailerWoolworthsAU
8652	BRAccountLinkingRetailerInstacart
8662	BRAccountLinkingRetailerUlta
9016	BRAccountLinkingRetailerShipt
9137	BRAccountLinkingRetailerUberEats
9416	BRAccountLinkingRetailerThriveMarket
9947	BRAccountLinkingRetailerChewy
10068	BRAccountLinkingRetailerSeamless
10078	BRAccountLinkingRetailerAmazonUK
10208	BRAccountLinkingRetailerGrubhub
10241	BRAccountLinkingRetailerDoordash
12099	BRAccountLinkingRetailerAmazonCA
12686	BRAccountLinkingRetailerAmazonES
12687	BRAccountLinkingRetailerAmazonDE
12688	BRAccountLinkingRetailerAmazonFR
12691	BRAccountLinkingRetailerSheinES
12749	BRAccountLinkingRetailerPcExpressCA
12819	BRAccountLinkingRetailerTemuUK
12848	BRAccountLinkingRetailerSheinUK
12849	BRAccountLinkingRetailerAliExpressUK
12850	BRAccountLinkingRetailerUberEatsUK
12881	BRAccountLinkingRetailerTemu
12882	BRAccountLinkingRetailerSheinUS
12948	BRAccountLinkingRetailerAmazonAU
13246	BRAccountLinkingRetailerAliExpress
19671	BRAccountLinkingRetailerPostmates

---

BREReceiptIMAPError

Error codes for IMAP-related operations.

typedef NS_ENUM(NSUInteger, BREReceiptIMAPError) { ... };

enum BREReceiptIMAPError : UInt

SDK Version: 3.2.0

Cases

Value	Objective-C Name	Swift Name
5	BREReceiptIMAPErrorInvalidCredentials	invalidCredentials
6	BREReceiptIMAPErrorGmailIMAPDisabled	gmailIMAPDisabled
40	BREReceiptIMAPErrorGmailTwoFactor	gmailTwoFactor

---

BREReceiptProvider

Identifies the email provider for an e-receipt account.

typedef NS_ENUM(NSUInteger, BREReceiptProvider) { ... };

enum BREReceiptProvider : UInt, @unchecked Sendable

SDK Version: 3.2.0
Defined in: BREmailAccount.h

Cases

Value	Objective-C Name	Swift Name
0	BREReceiptProviderNone	none
1	BREReceiptProviderGmail	gmail
2	BREReceiptProviderOutlook	outlook
3	BREReceiptProviderYahoo	yahoo
4	BREReceiptProviderAOL	aol
5	BREReceiptProviderGmailIMAP	gmailIMAP
6	BREReceiptProviderCustomIMAP	customIMAP
7	BREReceiptProviderYahooV2	yahooV2

---

BREReceiptRemoteError

Error codes for remote e-receipt scrape operations.

typedef NS_ENUM(NSUInteger, BREReceiptRemoteError) { ... };

enum BREReceiptRemoteError : UInt

SDK Version: 3.2.0

Cases

Value	Objective-C Name	Swift Name	Description
0	BREReceiptRemoteErrorNone	none	No error
1	BREReceiptRemoteErrorNoProvider	noProvider	Remote scrape was attempted but no providers have been linked
2	BREReceiptRemoteErrorInvalidProvider	invalidProvider	Remote scrape was attempted with a provider that is not supported
3	BREReceiptRemoteErrorNoCredentials	noCredentials	Remote scrape was attempted but no valid credentials were found on disk for the specified provider
4	BREReceiptRemoteErrorCantObtainToken	cantObtainToken	Remote scrape was attempted for an OAuth provider but a new access token could not be obtained
5	BREReceiptRemoteErrorInvalidCredentials	invalidCredentials	The supplied credentials failed to authenticate against the specified provider server side
6	BREReceiptRemoteErrorExpiredToken	expiredToken	For OAuth providers this indicates the access token has expired
7	BREReceiptRemoteErrorNoClientConfig	noClientConfig	No client configuration for the remote scrape service was found server side
8	BREReceiptRemoteErrorBadInput	badInput	Remote scrape worker could not locate all required parameters to initiate scrape (Unexpected)
9	BREReceiptRemoteErrorTimeout	timeout	Remote scrape worker timed out trying to connect to email provider
10	BREReceiptRemoteErrorIMAPNoBoxes	imapNoBoxes	Remote scrape worker connected to IMAP account but found no mailboxes (Unexpected)
11	BREReceiptRemoteErrorInvalidReceiptIDs	invalidReceiptIDs	Indicates that one or more receipt IDs passed in to a reprocessing job was invalid (will not be returned client side)
12	BREReceiptRemoteErrorClientEndpointErrors	clientEndpointErrors	Indicates failure to connect to the results endpoint configured server side (will not be returned client side)
13	BREReceiptRemoteErrorJobInProgress	jobInProgress	Could not queue up a remote scrape job because there is already one queued or in progress for this email address
16	BREReceiptRemoteErrorIMAPFailedConnection	imapFailedConnection	Could not connect to or authenticate with the IMAP server
999	BREReceiptRemoteErrorUnknown	unknown	An unknown error was encountered attempting to queue up the remote scrape job

---

BRSetupIMAPResult

Result codes returned after an IMAP setup flow completes.

typedef NS_ENUM(NSUInteger, BRSetupIMAPResult) { ... };

enum BRSetupIMAPResult : UInt, @unchecked Sendable

SDK Version: 3.2.0

Cases

Value	Objective-C Name	Swift Name
0	BRSetupIMAPResultUserCancelled	userCancelled
1	BRSetupIMAPResultBadEmail	badEmail
2	BRSetupIMAPResultBadPassword	badPassword
3	BRSetupIMAPResultEnabledLSA	enabledLSA
4	BRSetupIMAPResultRedirectToSafari	redirectToSafari
5	BRSetupIMAPResultCreatedAppPassword	createdAppPassword
6	BRSetupIMAPResultAdminNeeded	adminNeeded
7	BRSetupIMAPResultDuplicateEmail	duplicateEmail
8	BRSetupIMAPResultSaved	saved
9	BRSetupIMAPResultUnknownFailure	unknownFailure
10	BRSetupIMAPResultEnabled2FAAccountRequired	enabled2FAAccountRequired