DevelopersAPIReferencefiles
Upload
Stores the file in the wallet and returns its row. Attach it on upload with transactionIds, cryptoTransactionIds or securityTransactionIds (a security…
POST
bearerAuthheader
Authorization<token>A Walletguide API key (wg_…) or an OAuth bearer token. Paste the value only. Create a key under Wallet settings → API keys.
walletId*stringRow uuid
Format
uuidapplication/json- body
fileBase64*stringThe document, standard padded base64. At most 10 MB once decoded.
Length
1 <= lengthfileName*stringThe name to show, with its extension (statement.pdf). The extension decides parsing.
Length
1 <= lengthcontentType?stringMIME type. Defaults from the extension (application/pdf for .pdf).
Length
1 <= lengthtransactionIds?array<>Cash transactions to attach the file to.
cryptoTransactionIds?array<>Crypto transactions to attach the file to.
securityTransactionIds?array<>Security (buy/sell/dividend) transactions to attach the file to.
The stored file
application/json- response
id*stringFormat
uuidwalletId*stringFormat
uuidfirestoreId*string|nulltransactionIds*array<>cryptoTransactionIds*array<>securityTransactionIds*array<>filename*stringfileExtension*stringsize*integerRange
-2147483648 <= value <= 2147483647storagePath*stringparseStatus*stringValue in
"open""running""failed""succeeded"parseData*string|number|boolean|null||array<unknown>createdTime*|Format
date-timecreatedUserId*string|nulllastUpdatedTime*|Format
date-timelastUpdatedUserId*string|nullcurl -X POST 'https://api.walletguide.com/wallets/497f6eca-6276-4993-bfeb-53cbbbba6f08/files/upload' \ -H 'Content-Type: application/json' \ -d '{ "fileBase64": "string", "fileName": "string"}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480", "firestoreId": "string", "transactionIds": [ "390bdf4e-83f8-4d97-9b70-6548dddef7ab" ], "cryptoTransactionIds": [ "c16ecae0-d5ad-4bad-b2d4-6d2e923da4b9" ], "securityTransactionIds": [ "c24f3ed0-61ed-4cb8-bf61-f9d71e009e82" ], "filename": "string", "fileExtension": "string", "size": -2147483648, "storagePath": "string", "parseStatus": "open", "parseData": "string", "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string"}