Skip to main content
POST
/
v1
/
files
Create File
curl --request POST \
  --url https://api.example.com/v1/files \
  --header 'Content-Type: application/json' \
  --data '
{
  "fileName": "<string>",
  "contentType": "application/pdf",
  "purpose": "authorization_attachment"
}
'
{
  "file": {
    "id": "<string>",
    "status": "pending_upload",
    "fileName": "<string>",
    "contentType": "application/pdf",
    "purpose": "authorization_attachment",
    "createdAt": "2023-11-07T05:31:56Z",
    "sizeBytes": 123,
    "completedAt": "2023-11-07T05:31:56Z",
    "uploadUrl": "<string>",
    "downloadUrl": "<string>"
  },
  "upload": {
    "url": "<string>",
    "strategy": "single_put",
    "method": "PUT",
    "headers": {}
  }
}

Body

application/json
fileName
string
required
contentType
enum<string>
required
Available options:
application/pdf,
image/jpeg,
image/png
purpose
enum<string>
required
Available options:
authorization_attachment,
test_ingress_payer_document

Response

Successful Response

file
FileDto · object
required
upload
SinglePutUpload · object
required