Use the Upload your data files to generate the upload URL request to generate the pre-signed upload URL and unique file identifiers.

Base URL:

https://vat-compliance-service.vertexcloud.com/documents

Upload your data files to generate the upload URL endpoint	Upload your data files to generate the upload URL description
`/url`	POST - Upload your data files into VAT Compliance.

Request

All request parameters are required.

Upload your data files to generate the upload URL parameter name	Upload your data files to generate the upload URL request parameter format	Upload your data files to generate the upload URL request parameter description
`metadata`	object	A metadata object containing the `profileName`
`profileName`	string	The unique customer-defined profile name, such as `customerProfile123`
`mimeType`	string	The mime type of the upload file. Accept the default value: `text_plain`
`name`	string	The name of the file being uploaded, such as `CustomerDataFile.csv`
`hash`	string	The SHA-256 hash code you generate using the hash.html file

Example request

curl --request POST \
     --url https://vat-compliance-service.vertexcloud.com/documents/url \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "metadata": {
    "profileName": "customerProfile123"
  },
  "mimeType": "text_plain",
  "name": "CustomerDataFile.csv",
  "hash": "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad"
}
'

Response

A response includes the filename, URL, and unique identifying information. The URL is valid for 24 hours from the time it is generated.

Upload your data files to generate the upload URL response field	Upload your data files to generate the upload URL response description
`filename`	A unique string representing the file name
`fileId`	The internal seven-digit file ID
`url`	The complete pre-signed S3 URL where you can upload the customer data file
`vrn`	Vertex Resource Name (VRN) is a unique identifier for cloud platform resources

Example response

{
    "fileName": "file_example-text-string",
    "fileId": NNNNNNN,
    "url": "https://vtx-fis-dev.s3.us-east-2.amazonaws.com/...&X-Amz-Signature=example-text-string...",
    "vrn": "vrn:fis:476edffe-...:file:example-text-string"
}

Save the response information for future use.