Upload supporting documents (e.g., invoice, payroll, etc.) for a specific transaction for compliance review; if the quote/transaction indicates DOCUMENT_REQUIRED, you must upload at least one valid document before the transaction can be confirmed.
Two-Step Document Process
This API process requires two sequential calls using two different HTTP methods on the same endpoint to manage the document associated with a specific transaction.
1. Upload Document (Initial Call)
Purpose: This step accepts the raw document file and initiates the upload process. A successful response confirms the document has been received and is typically held in a temporary or uploaded state.
Path Parameter:{id} - The unique ID of the remittance transaction the document belongs to.
Requirement: This is the prerequisite step. The document must be uploaded successfully before the confirmation step can be initiated.
2. Confirm Upload (Finalization Call)
Purpose: This step finalizes the document submission using the same resource path. It signals to the system that the document upload is complete, updates the transaction's status, and proceed with the transaction.
Path Parameter:{id} - The unique ID of the remittance transaction being confirmed.
Key Difference: The primary difference between the POST and PUT calls on this path is that the POST carries the file data, while the PUT usually carries a light confirmation payload (or sometimes no payload) to signal finalization.
Requirement: Must be called only after the document has been successfully uploaded via the POST request.
Header Parameters
X-Auth-User-IDstring Required
MatchMove provided ID for the user.
Authorizationstring
Path Parameters
idstring Required
Transaction ID
Body Parameters
filearray
The actual file to be uploaded. Max size: 5MB.
Show child attributes
document_typestring
Document type
Enum values:
INVOICEPAYROLLBANK_STATEMENT
categorystring
Document category
Default value
TRANSFER_PURPOSE
Enum values:
TRANSFER_PURPOSE
Response
201
Object
Created
Response Attributes
submission_idstring
Submission ID
transaction_idstring
Represents the ID of the transaction which the document is related to
categorystring
Document category
Default value
TRANSFER_PURPOSE
Enum values:
TRANSFER_PURPOSE
statusstring
Represents the status of the submitted documents
Enum values:
UPLOADED
documentsarray
List of uploaded documents
Show child attributes
countinteger
Uploaded document count
400
Object
Bad Request
| **Code** | **Title** | **Detail** |
| ---------------------------------------------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| invalid_model | Invalid Model | Request body is invalid. |
| invalid_user_id | Invalid User ID | User does not exist. Please provide a valid user id. |
| user_not_active | User Not Active | User is not active. |
| invalid_transaction | Invalid Transaction | Transaction not found. |
| validation_error | Validation Error | Validation errors. |
Response Attributes
idstring Required
Unique hash-id for the error message
statusinteger Required
Error response status code
codestring Required
Error response code
titlestring Required
Error response title
detailstring Required
Error response detail
sourcearray,string
Source defines the multiple error messages
Show child attributes
timestampstring Required
Response timestamp
401
Object
Unauthorized
| **Code** | **Title** | **Detail** |
| ---------------------------------------------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| token_required | Token Required | Access denied due to invalid token on header. |
| invalid_tenant | Invalid Tenant | Access denied due to invalid tenant code. |
Response Attributes
idstring Required
Unique hash-id for the error message
statusinteger Required
Error response status code
codestring Required
Error response code
titlestring Required
Error response title
detailstring Required
Error response detail
sourcearray,string
Source defines the multiple error messages
Show child attributes
timestampstring Required
Response timestamp
403
Object
Forbidden
| **Code** | **Title** | **Detail** |
| ---------------------------------------------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| restricted_resource | Restricted Resource | Access denied to the resource. If your access key and source IP is correct, it would be because of `X-Auth-User-ID` is not passed on header. |
| unauthorized_access | Unauthorized Access | Transaction does not belong to user. |
| upload_not_required | Upload Not Required | No additional document required for this transaction. |
Response Attributes
idstring Required
Unique hash-id for the error message
statusinteger Required
Error response status code
codestring Required
Error response code
titlestring Required
Error response title
detailstring Required
Error response detail
sourcearray,string
Source defines the multiple error messages
Show child attributes
timestampstring Required
Response timestamp
413
Object
Unauthorized
| **Code** | **Title** | **Detail** |
| ---------------------------------------------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| payload_too_large | Payload Too Large | File too large. Supported max file size is 5MB. |
Response Attributes
idstring Required
Unique hash-id for the error message
statusinteger Required
Error response status code
codestring Required
Error response code
titlestring Required
Error response title
detailstring Required
Error response detail
sourcearray,string
Source defines the multiple error messages
Show child attributes
timestampstring Required
Response timestamp
415
Object
Unauthorized
| **Code** | **Title** | **Detail** |
| ---------------------------------------------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| unsupported_media | Unsupported Media | File type is not supported. Supported file types: [application/pdf,image/jpeg,image/png]. |
