Skip to main content
POST
Register document

Authorizations

X-PayFi-Api-Key
string
header
required
X-PayFi-Nonce
string
header
required
X-PayFi-Signature
string
header
required
Idempotency-Key
string
header
required

Path Parameters

operationId
string
required

Operation ID.

Body

application/json

Document metadata.

documentType
enum<string>
required
Available options:
invoice,
bill_of_lading,
packing_list,
di_duimp,
bank_details,
proforma,
service_contract,
insurance_policy
Example:

"invoice"

fileName
string
required
Example:

"invoice-123.pdf"

contentType
string
required
Example:

"application/pdf"

sizeBytes
number
required
Example:

123456

Response

Document registered.

documentId
string
Example:

"doc_example"

status
enum<string>
Available options:
REGISTERED,
UPLOAD_PENDING,
UPLOADED,
SCANNING,
CLEAN,
REJECTED,
PROCESSING,
PROCESSED,
PROCESSING_FAILED
Example:

"UPLOAD_PENDING"

uploadUrl
string
Example:

"https://storage.example.com/presigned-upload"

uploadUrlExpiresInSeconds
number
Example:

300