> ## Documentation Index > Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt > Use this file to discover all available pages before exploring further. # Data Processed by Vantage Mobile Input > Data flow and API calls used by Vantage Mobile Input on iOS and Android to create documents, upload images, and start processing transactions in Vantage. export const VantageRegion = ({children}) => { const STORAGE_KEY = "abbyy.vantage.region"; const REGIONS = [{ code: "eu", label: "Europe" }, { code: "us", label: "North America" }, { code: "au", label: "Australia / Asia-Pacific" }]; const [region, setRegion] = useState("eu"); const [open, setOpen] = useState(false); const containerRef = useRef(null); const dropdownRef = useRef(null); function safeGetSavedRegion() { try { const saved = typeof window !== "undefined" ? window.localStorage.getItem(STORAGE_KEY) : null; const valid = new Set(REGIONS.map(r => r.code)); return saved && valid.has(saved) ? saved : "eu"; } catch { return "eu"; } } function safeSetSavedRegion(code) { try { if (typeof window !== "undefined") { window.localStorage.setItem(STORAGE_KEY, code); } } catch {} } function dispatchRegionChanged(code) { try { if (typeof window !== "undefined") { window.dispatchEvent(new CustomEvent("abbyy:region-changed", { detail: { code } })); } } catch {} } function replaceRegionInString(text, currentRegion) { if (typeof text !== "string") return text; const hostRegex = /https:\/\/vantage-(eu|us|au)\.abbyy\.com/gi; const tokenRegex = /https:\/\/vantage-\[region\]\.abbyy\.com/gi; const bareHostRegex = /vantage-(eu|us|au)\.abbyy\.com/gi; const bareTokenRegex = /vantage-\[region\]\.abbyy\.com/gi; return text.replace(hostRegex, `https://vantage-${currentRegion}.abbyy.com`).replace(tokenRegex, `https://vantage-${currentRegion}.abbyy.com`).replace(bareHostRegex, `vantage-${currentRegion}.abbyy.com`).replace(bareTokenRegex, `vantage-${currentRegion}.abbyy.com`); } useEffect(() => { setRegion(safeGetSavedRegion()); }, []); useEffect(() => { const root = containerRef.current; if (!root) return; const anchors = root.querySelectorAll("a[href]"); anchors.forEach(a => { const href = a.getAttribute("href"); if (href) { const next = replaceRegionInString(href, region); if (next !== href) { a.setAttribute("href", next); } } }); const walker = typeof document !== "undefined" ? document.createTreeWalker(root, NodeFilter.SHOW_TEXT, null) : null; if (walker) { const toUpdate = []; let node = walker.nextNode(); while (node) { const updated = replaceRegionInString(node.nodeValue, region); if (updated !== node.nodeValue) { toUpdate.push([node, updated]); } node = walker.nextNode(); } toUpdate.forEach(([textNode, value]) => { textNode.nodeValue = value; }); } }, [region, children]); useEffect(() => { const root = containerRef.current; if (!root) return; const anchors = root.querySelectorAll("a[href]"); anchors.forEach(a => { a.style.fontWeight = "600"; a.style.textDecoration = "underline"; a.style.textUnderlineOffset = "2px"; }); }, [region, children]); useEffect(() => { const onRegionChanged = evt => { const code = evt && evt.detail && evt.detail.code; if (!code || code === region) return; setRegion(code); }; if (typeof window !== "undefined") { window.addEventListener("abbyy:region-changed", onRegionChanged); } return () => { if (typeof window !== "undefined") { window.removeEventListener("abbyy:region-changed", onRegionChanged); } }; }, [region]); useEffect(() => { const onClickAway = e => { if (!dropdownRef.current) return; if (!dropdownRef.current.contains(e.target)) { setOpen(false); } }; document.addEventListener("click", onClickAway, true); return () => document.removeEventListener("click", onClickAway, true); }, []); const onSelect = code => { setRegion(code); safeSetSavedRegion(code); dispatchRegionChanged(code); setOpen(false); }; const current = REGIONS.find(r => r.code === region) || REGIONS[0]; return
Tenant Region:
{open ?
{REGIONS.map(r => { const selected = r.code === region; return ; })}
: null}
{children}
; }; Vantage Mobile Upload communicates with the Vantage server by using API calls. These calls are used to create documents, upload images, and start processing transactions with certain parameters. ## API calls by platform ### iOS platform The iOS micro application of Vantage Mobile Input uses the following API calls: 1. Sending parameters of the input session to the Vantage Mobile Upload Backend 2. Getting parameters of the input session from the Vantage Mobile Upload Backend 3. Getting status of the transaction 4. Downloading models for analyzing images of the documents 5. Getting list of the documents in the transaction 6. Deleting existing documents in the transaction 7. Creating a document in the transaction 8. Uploading captured images to the document 9. Starting the transaction ### Android platform The Android micro application of Vantage Mobile Input uses the following API calls: 1. Getting status of the transaction 2. Downloading models for analyzing images of the documents 3. Getting list of the documents in the transaction 4. Deleting existing documents in the transaction 5. Creating a document in the transaction 6. Uploading captured images to the document 7. Starting the transaction ## Sending input session parameters to the Vantage Mobile Upload Backend Vantage Mobile Input sends input session parameters to the Vantage Mobile Upload Backend. These parameters are used for the upload session in the Android micro application or in the web browser. ### Input session parameters | Key | Description | | :------------ | :------------------------------------------------------------------------------------------------------------------ | | BaseURL | The main domain of Vantage server. | | TransactionID | The identifier of the transaction. | | Token | The encoded authorization access token that is used for authorized access to the Vantage API. | | v | The version of the Vantage API. | | md | The quantity of the documents that will be captured in one transaction. | | redirect\_uri | The redirect link that opens once Vantage Mobile Upload is finished. | | dt | The document type. | | ma | The ABBYY Vantage cloud environment address that is used to start micro applications for on-premises installations. | Request: ``` curl -X POST "https://mobilesessionmanager-eu.abbyy.com/api/v1/mobilesessions" -H "accept: text/plain" \ -H "Content-Type: application/json" \ -F "Body= { "sessionAuxiliaryKey": "string", "sessionData": "string" } ``` Response: ``` Status code of the request ``` ## Getting input session parameters from Vantage Mobile Upload Backend To get the input session parameters, Vantage Mobile Upload sends requests to Vantage Mobile Upload Backend. ### Input session parameters | Key | Description | | :------------ | :------------------------------------------------------------------------------------------------------------------ | | BaseURL | The main domain of Vantage server. | | TransactionID | The identifier of the transaction. | | Token | The encoded authorization access token that is used for authorized access to the Vantage API. | | v | The version of the Vantage API. | | md | The quantity of the documents that will be captured in one transaction. | | redirect\_uri | The redirect link that opens once Vantage Mobile Upload is finished. | | dt | The document type. | | ma | The ABBYY Vantage cloud environment address that is used to start micro applications for on-premises installations. | Request: ``` curl -X POST "https://mobilesessionmanager-eu.abbyy.com/api/v1/mobilesessions/retrive" -H "accept: text/plain" \ -H "Content-Type: application/json" \ -F "Body= { "userCode": "String" } ``` Response: ``` { "sessionData": "" } ``` Sample of input session parameters: ``` { \"sessionData\": \"https://mobilesessionmanager-eu.abbyy.com/mobile?baseUrl=&transactionId=&token=&v=\" } ``` ## Getting the status of the transaction Vantage Mobile Upload sends a request to get the transaction identifier and status. Only transactions with the **New** status are valid for uploading documents. **Key parameters** | Key | Description | | :------------ | :---------------------------------------------------------------------------------- | | TransactionID | The identifier of the transaction. | | Status | The status of the transaction. Possible values: New, Started, Processing, Processed | Request: ``` GET https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id ``` Response: ``` { "id": "", "status": "" } ``` ## Downloading the models for analyzing images of the documents Vantage Mobile Upload sends requests to download models for detecting page edges on the images of the documents for the iOS micro application. **Key parameters** | Key | Description | | :------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | AbbyyRtrSDK-version | The version of AbbyyRtrSDK framework used to request the relevant pattern files. The value may change depending on the version of Vantage. | | PatternFileName | The name of the AbbyyRtrSDK file pattern that is used for detecting page edges on the images of the documents. There are six types of file patterns: `FactCrop.imodel`, `CnnCrop.Classifier.cnnmodel`, `DIQClassifier.imodel`, `CnnCrop.Detector.GenericWithID.cnnmodel`, `DIQBlockClassifier.imodel`, `CropClassifierPhoto.imodel` | Request: ``` GET https://vantage-us.abbyy.com/app_clip/mobile_sdk_assets/AbbyyRtrSDK-version/patterns/PatternFileName ``` Response: ``` File pattern ``` ## Getting a list of the documents in the transaction Before uploading documents to the transaction, Vantage Mobile Upload sends a request to check the transaction for previously created documents. If the transaction is not empty, Vantage Mobile Upload sends a **Delete document** request to delete all existing documents before a new upload session. **Key parameters** | Key | Description | | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | TransactionID | The identifier of the transaction. | | DocumentID | The identifier of the document received from the **Creating a document** request. | | SourceFileID | The identifier of the document image. | | SourceFileName | The name of the document image. Vantage Mobile Upload automatically generates file names for each image and uploads images to the document using the **Uploading Images to the document** request. | Request: ``` GET https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents ``` Response: ``` [ { "documentId": "", "sourceFiles": [ { "id": "", "name": ".JPG" } ] }, { "documentId": "", "sourceFiles": [ { "id": "", "name": ".JPG" } ] } ] ``` ## Deleting existing documents in the transaction To remove a document from the transaction before starting processing, use `DELETE /api/publicapi/v1/transactions/{transactionId}/documents/{documentId}`. This allows users to: * Remove incorrectly captured documents * Clear documents before re-capturing * Manage document sets in the transaction Documents can only be deleted before the transaction starts processing. ## Creating a document in the transaction To upload images Vantage Mobile Upload sends a request to create document instances for each document in the transaction. **Key parameters** | Key | Description | | :------------ | :-------------------------------------------------------------------------------------------- | | Token | The encoded authorization access token that is used for authorized access to the Vantage API. | | TransactionID | The identifier of the transaction. | | DocumentID | The identifier of the document. | Request: ``` curl -X POST "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents" -H "accept: */*" \ -H "Authorization: Bearer token" \ -H "Content-Type: application/json; charset=utf-8" \ -F "Model= { "index": , "imageProcessingOptions": { "autoOrientationCorrection": "", "autoCrop": "" } } ``` Response: ``` { "documentId": "" } ``` ## Uploading captured images to the document Once the document instance has been created, Vantage Mobile Upload sends a request to upload all the images to the document. All images for one document are uploaded in a single request. **Key parameters** | Key | Description | | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------ | | Token | The encoded authorization access token that is used for authorized access to the Vantage API. | | TransactionID | The identifier of the transaction. | | DocumentID | The identifier of the document received from the **Creating a document** request. | | SourceFileID | The identifier of the document image. | | SourceFileName | The name of the document image. Vantage Mobile Upload automatically generates file names for each image and uploads images to the document. | | ImageData | The encoded information from the image files. Used to upload images to documents. | Request: ``` curl -X POST "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles" -H "accept: */*" \ -H "Authorization: Bearer token" \ -H "Content-Type: multipart/form-data; boundary=" \ -F "Body= { "files": [ { "index": 0, "registrationParameters": [ { "key": "SourceType", "value": "Vantage Mobile Capture" } ] } ] }, { "index": 1, ... }, ... ] } Content-Disposition: form-data; name="Files"; filename=".JPG" Content-Type: image/jpeg ... Content-Disposition: form-data; name="Files"; filename=".JPG" Content-Type: image/jpeg ... ``` Response: ``` Status code of the request ``` ## Starting the transaction Once all the documents have been created and all the images have been uploaded to the documents, Vantage Mobile Upload sends a request to start the transaction. **Key parameters** | Key | Description | | :------------ | :-------------------------------------------------------------------------------------------- | | Token | The encoded authorization access token that is used for authorized access to the Vantage API. | | TransactionID | The identifier of the transaction. | Request: ``` curl -X POST "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/start" -H "accept: */*" \ -H "Authorization: Bearer token" \ -H "Content-Type: application/json; charset=utf-8" \ ``` Response: ``` Status code of the request ```