Request Upload

post/v1/flows/{flow_id}/documents

Request Upload

Authentication

Send your tenant secret key as a Bearer token. Keep secret keys on your server; never ship them in browser or mobile code.

Parameters

flow_id

path · required

No additional parameter description.

Request body

JSON · required

doc_type

DocumentTyperequired

No additional field description.

mime_type

string | null

No additional field description.

side

DocumentSide

No additional field description.

Example request

cURL

curl --request POST \
  --url 'https://api.fideralabs.com/v1/flows/{flow_id}/documents' \
  --header 'Authorization: Bearer $FIDERA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "doc_type": "string",
  "mime_type": "image/jpeg",
  "side": "single"
}'

Responses

201Successful Response

doc_type

DocumentTyperequired

No additional field description.

id

stringrequired

No additional field description.

side

DocumentSiderequired

No additional field description.

upload

PresignedUploadOutrequired

No additional field description.

upload_status

UploadStatusrequired

No additional field description.

application/json

{
  "doc_type": "string",
  "id": "00000000-0000-0000-0000-000000000000",
  "side": "string",
  "upload": {
    "expires_in": 0,
    "headers": {},
    "method": "string",
    "url": "string"
  },
  "upload_status": "string"
}

422Validation Error

detail

ValidationError[]

No additional field description.

Operation ID

request_upload_v1_flows__flow_id__documents_post