FTOS_BP_GetProductDocuments

Returns the information regarding the documents attached to a banking product based on its product code or id.

Syntax

The FTOS_BP_GetProductDocuments custom endpoint is called from within the Endpoint API endpoint. Visit the Endpoint API page for more details.

Copy 
POST <host_address>/ftosapi/automation-processors/actions/ftos_bp_getproductdocuments
Content-Type: application/json
            
{
  "productCode": "<product_code>"
}

Here's a list of the available parameters:

Parameter Description
host_address URL of the FintechOS Platform server.
productCode Mandatory when productId is not sent, string. The code of the banking product.
bankingProductId Mandatory when productCode is not sent, string. The id of the banking product.

Response

The response is an object with data from the FTOS_BP_BankingProductDocument entity for the specified banking product.

Example

To view the information regarding the documents attached to a specific banking product, send the following request, changing the code of the product with the one you need.

Request

Copy 
POST https://your_FintechOS_server/ftosapi/automation-processors/actions/ftos_bp_getproductdocuments
Content-Type: application/json
            
{
  "productCode": "TL_ADV"
}

Response

Copy 
[
    {
        "Doc": {
            "ReportId": "f6cdcf1e-6c63-4554-a3ee-cec73906a92e",
            "IsMandatory": null,
            "IsAccord": null
        },
        "Report": {
            "DisplayName": "Contract Repayment Schedule"
        }
    }
]

To view the information regarding the documents attached to a specific banking product, send the following request, changing the id of the product with the one you need.

Request

Copy 
POST https://your_FintechOS_server/ftosapi/automation-processors/actions/ftos_bp_getproductdocuments
Content-Type: application/json
            
{
  "bankingProductId": "EEC720BA-6C32-47AC-9050-3D9D759F043E"
}

Response

Copy 
[
    {
        "Doc": {
            "ReportId": "f6cdcf1e-6c63-4554-a3ee-cec73906a92e",
            "IsMandatory": null,
            "IsAccord": null
        },
        "Report": {
            "DisplayName": "Contract Repayment Schedule"
        }
    }
]