Evidence file upload - API Reference

Evidence file upload

POST

Try it

Upload a single file as dispute evidence.

Credentials

HTTP Basic basicAuth

Header Parameters

Parameter	Type	Required
api-version	string	*
x-forter-siteid	string	*

Body Parameters

Parameter	Type	Required
body	disputeEvidenceFileRequestRequest	*
evidenceType	string<PROOF_OF_DELIVERY \	PROOF_OF_REFUND \
filePath	string	*
orderId	string	nullable
processorCaseNumber	string	nullable
processorChargeId	string	nullable

Responses

200

Example disputeEvidenceFileResponse

The response object following uploading dispute evidence file request to the system

Parameter	Type	Required
message	string	*
status	string	*

400

Bad Request

Parameter	Type	Required
message	string<CLAIM_NOT_FOUND \	SCHEMA_VALIDATION_FAILED>
status	string	*

401

Unauthorized (No valid API key provided)

404

Not Found (The requested item doesn't exist)

500

Server Error

Parameter	Type	Required
message	string	*
status	string	*

Request

Curl

curl --request POST \ 
--url https://api.forter-secure.com/v3/disputes/evidence/file \ 
--header 'accept: application/json' \ 
--header 'content-type: application/json' \ 
--header 'api-version: 10.1' \ 
--header 'x-forter-siteid: a1b2c3d4e5f6' \ 
--data '{
  "evidenceType": "PROOF_OF_DELIVERY",
  "filePath": "s3://forter-bucket/client-folder/dispute-evidence/example-16451.pdf"
}'

Responses

200

Example

{
  "message": "EVIDENCE_UPLOADED",
  "status": "SUCCESS"
}