Upload File
Endpoint: POST /v2/gc/files/upload
Description: Upload a supporting document (KYC, contract, logistics, payee proof, etc.) and obtain a reusable file path for use in other API calls.
Request
Request Form-Data Field Descriptions
bizType
string
Yes
Document category. Enum: PAYMENT | UPLOAD | REPORT | CUSTOMS_RECEIPT | NETWORK_ACCESS | COMMERCIAL | LOGISTICS | PAYEEINFO | OTHER
file
file
Yes
The binary document to upload (e.g. PDF, image).
The bizType enum list above was not independently re-verified against the backend for this pass — it's carried over from the prior version of this page. Treat it as likely-correct but unconfirmed; verify with the NeoX integration team if a specific bizType value is rejected.
Request sample
// multipart/form-data request — see the form-data field table above; no JSON body.Response
Response Field Descriptions
code
number
Response code. 1 on success; a failure uses a different code (e.g. 2080) with message describing the error.
data
array
Uploaded file details — see below.
message
string
Response message.
There is no state field in the response envelope. data is an array, not a single object — even for a single-file upload, the response wraps the result in a one-element array.
data array item fields:
fileName
string
Original file name of the uploaded document.
path
string
Reusable file reference path. Pass this value in other API calls (e.g. kycFiles, contractFiles, attachmentsFiles, detailPath, frontPath).
Response sample
Failure response shape:
Example cURL
Notes
Requires Bearer token in the Authorization header.
The Accept-Language header can be used to specify the response language (Support: "vi", "en").
The request must be sent as
multipart/form-data; do not useapplication/json.The returned
pathvalue is used as a file reference in other API calls, includingkycFiles,contractFiles,paymentProofList,detailPath,frontPath, and similar fields.Choose the
bizTypevalue that best matches the document's intended purpose.
Last updated
Was this helpful?