Documents
Use the Documents APIs to attach and manage application documents.
What are application documents?
Merchant applications require certain documents such as processing statements or principal owner's id.
FlexFactor team will review them in accordance with the rest of the application before issuing an
APPROVEDorDECLINEDstatus.
Document Management Endpoints
| endpoint | link to documentation |
|---|---|
| POST /v1/onboarding/application/{id}/documents/ | Attach a document to an application. |
| GET /v1/onboarding/application/{id}/documents/ | Retrieve all documents attached to a specific application. |
| GET /v1/onboarding/application/{id}/documents/{documentID} | Retrieve the details of a specific document. |
| DELETE /v1/onboarding/application/{id}/documents/{documentID} | Delete a document associated with an application. |
General Information
The Document Management API enables seamless handling of documents related to onboarding applications. These APIs are RESTful and use standard HTTP methods (POST, GET, DELETE) to perform operations such as uploading, retrieving, and deleting documents.
Some requests require data in the message body (e.g., for uploading a document), while others use URL parameters to specify the target document or application.
Endpoints
Sandbox testing | |
Production environment |
The sandbox environment is completely isolated for testing purposes. Experiment freely without impacting production systems. When you’re ready for deployment, production credentials will provide access to the live system.
Do not upload sensitive or real-world financial data in the Sandbox environment.
Headers
To interact with the Document Management API, ensure the following headers are included in your requests:
| Name | Description | Request Type | Value |
|---|---|---|---|
| authorization | Every request must be authenticated. | GET, POST, DELETE | Bearer token |
| content-type | Specifies the media type of the resource. | POST | multipart/form-data or application/json |
Versioning
The Document Management API follows the versioning protocol outlined in the base API documentation.
For example, <https://api.flex-charge.com/v1/onboarding/application/{id}/documents/> indicates version 1 of the API.
Backward-incompatible updates will increment the version number, while minor enhancements and fixes do not.
Ensure that your implementation can handle API revisions, including additional, unspecified response fields or variable response sizes.
Errors
The Document Management API uses standard HTTP response codes to indicate success or failure. Below is a list of common response codes and their meanings:
| Response Code | Description |
|---|---|
| 200 OK | The request completed successfully. |
| 201 Created | Resource created successfully. |
| 204 No Content | Returned on a successful DELETE request. |
| 400 Bad Request | The request is malformed or missing required parameters. |
| 401 Unauthorized | Authentication failed. Provide valid credentials to proceed. |
| 403 Forbidden | Access to the resource is denied. |
| 404 Not Found | The specified application or document could not be located. |
| 405 Method Not Allowed | The HTTP method used is not allowed for this resource. |
| 500 Internal Server Error | An unexpected error occurred on the server. |
| 502 Bad Gateway | Received an invalid response from the upstream server. |
| 503 Service Unavailable | The server is temporarily unable to process the request. |
| 504 Gateway Timeout | The server timed out while attempting to process the request. |
Updated 2 months ago