---
updatedAt: 2026-09-30T07:42:16.000Z
agentTools:
  projectIndex: https://devportal.fintensy.com/llms.txt
---

# Notify new bundle available

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Digital Signature API",
    "description": "API definition for the Digital Signature services exposed by Fintensy and consumed by Record Credits.",
    "version": "1.0.0",
    "contact": {
      "name": "Fintensy API Team",
      "url": "https://www.fintensy.com"
    }
  },
  "servers": [
    {
      "url": "https://{{base_url}}",
      "description": "ACC – Application service (DEV)"
    },
    {
      "url": "https://record-identity-dev.digitalisedsvices.com",
      "description": "ACC – Identity service (DEV)"
    },
    {
      "url": "https://record-platform-dev.digitalisedsvices.com",
      "description": "ACC – Platform service (DEV)"
    },
    {
      "url": "https://record-app.digitalisedsvices.com",
      "description": "PRD – Application service"
    },
    {
      "url": "https://record-identity.digitalisedsvices.com",
      "description": "PRD – Identity service"
    },
    {
      "url": "https://record-platform.digitalisedsvices.com",
      "description": "PRD – Platform service"
    }
  ],
  "paths": {
    "/api/bundles": {
      "post": {
        "description": "",
        "operationId": "post_apibundles",
        "responses": {
          "200": {
            "description": "Successfully notified a new bundle available",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Returns the Fintensy internal guid of the bundle created"
                    }
                  },
                  "required": [
                    "id"
                  ]
                },
                "examples": {
                  "OK": {
                    "summary": "OK",
                    "value": {
                      "id": "08846b35-298a-40d3-90cd-b3e900b4847c"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "number",
                      "description": "Internal functional error code returned."
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message in plain text"
                    },
                    "errors": {
                      "type": "object",
                      "description": "Error details object"
                    }
                  },
                  "required": [
                    "code",
                    "message",
                    "errors"
                  ]
                },
                "examples": {
                  "Bad Request": {
                    "summary": "Bad Request",
                    "value": "{\"code\":\"10000101\",\"message\":\"Validation error occurred\",\"errors\":[{\"field\":\"branch_external_reference\",\"actual_value\":\"999983\",\"code\":4004,\"min_length\":null,\"max_length\":null}]}{}"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {}
          },
          "500": {
            "description": "Internal Server Error",
            "content": {}
          }
        },
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "branch_external_reference": {
                    "type": "string",
                    "description": "Partner branch or broker identifier. Example: 4473635",
                    "default": ""
                  },
                  "reference": {
                    "type": "string",
                    "description": "Case reference used by the partner. Example: E023442",
                    "default": ""
                  },
                  "external_reference_id": {
                    "type": "string",
                    "description": "External reference identifier of the bundle provided by the integration side and propagated unchanged across bundle-related endpoints. Example: 30dd879c-ee2f-11db-8314-0800200c9a66"
                  },
                  "archive_previous_bundles": {
                    "type": "boolean",
                    "description": "Boolean flag indicating whether previous bundles for the same reference should be archived",
                    "default": "false"
                  },
                  "file_name": {
                    "type": "string",
                    "description": "Name of the PDF bundle file as provided by the partner. Example: {brokerId}_{dossierNr}_{contractNr}_{SEQ}_bundle.pdf = \"313725_E098543_934301835987_01_bundle.pdf\"",
                    "default": ""
                  },
                  "source": {
                    "type": "string",
                    "description": "Source channel from which the bundle is provided",
                    "default": "sftp",
                    "enum": [
                      "manual",
                      "sftp",
                      "s3"
                    ]
                  },
                  "channel_type": {
                    "type": "string",
                    "description": "Business channel initiating the bundle",
                    "default": "",
                    "enum": [
                      "broker",
                      "vendor"
                    ]
                  },
                  "credit_type": {
                    "type": "string",
                    "description": "Type of credit associated with the bundle. Used to determine whether regulated-loan specific features, such as the withdrawal action, are applicable. Allowed values: consumer, professional."
                  },
                  "remote_signing": {
                    "type": "boolean",
                    "description": "Indicates whether the bundle allows a remote digital signature flow",
                    "default": ""
                  },
                  "street": {
                    "type": "string",
                    "description": "Street part of the address for the signature location"
                  },
                  "street_number": {
                    "type": "string",
                    "description": "Street number part of the address for the signature location"
                  },
                  "street_additionnal_information": {
                    "type": "string",
                    "description": "Additional information part of the address for the signature location"
                  },
                  "zip_code": {
                    "type": "string",
                    "description": "Zip code part of the address for the signature location"
                  },
                  "country": {
                    "type": "string",
                    "description": "Country part of the address for the signature location"
                  },
                  "signers": {
                    "type": "object",
                    "properties": {
                      "email": {
                        "type": "string",
                        "description": "Email address of the signer",
                        "default": ""
                      },
                      "first_name": {
                        "type": "string",
                        "description": "Signer’s first name",
                        "default": ""
                      },
                      "last_name": {
                        "type": "string",
                        "description": "Signer’s last name",
                        "default": ""
                      },
                      "role": {
                        "type": "number",
                        "description": "Role of the signer within the bundle. Example: Unknown = 0, Primary = 1, Secondary = 2, Broker = 3",
                        "default": "",
                        "enum": [
                          0,
                          1,
                          2,
                          3
                        ]
                      },
                      "date_of_birth": {
                        "type": "string",
                        "description": "Signer date of birth in yyyy-mm-dd format.\nRequired for roles 1 & 2\nOptional for role 3\n\nIn case of the birthdate not known, default governmental case is supported (e.g. \"1976-00-01\")"
                      },
                      "national_identification_number": {
                        "type": "string",
                        "description": "Signer’s national identification number used for identity verification.\nRequired for roles 1 & 2\nOptional for role 3",
                        "default": ""
                      },
                      "gender": {
                        "type": "string",
                        "description": "Signer’s gender code if available",
                        "default": "F",
                        "enum": [
                          "F",
                          "M"
                        ]
                      },
                      "language": {
                        "type": "string",
                        "description": "Preferred language of the signer, ISO 2-letter code",
                        "default": ""
                      },
                      "mobile_phone_number": {
                        "type": "string",
                        "description": "Signer mobile phone number in international (E.164) format\n",
                        "default": ""
                      },
                      "life_insurance_premium_financing_requested": {
                        "type": "boolean",
                        "description": "Indicates whether financing of the outstanding balance insurance premium is requested through the loan. Nullable when not applicable. Example: true"
                      },
                      "life_insurance_premium_amount": {
                        "type": "number",
                        "description": "Amount of the outstanding balance insurance premium to be financed through the loan for this applicant. Example: 185.20"
                      }
                    },
                    "required": [
                      "email",
                      "first_name",
                      "last_name",
                      "language",
                      "role",
                      "gender",
                      "date_of_birth"
                    ]
                  }
                },
                "required": [
                  "branch_external_reference",
                  "reference",
                  "archive_previous_bundles",
                  "file_name",
                  "channel_type",
                  "remote_signing",
                  "signers",
                  "source",
                  "street",
                  "zip_code",
                  "country",
                  "external_reference_id",
                  "credit_type"
                ]
              },
              "examples": {
                "New bundle available": {
                  "summary": "New bundle available",
                  "value": "{\n    \"branch_external_reference\": \"{broker_id}\",\n    \"reference\": \"{dossierNr}\",\n    \"external_reference_id\": \"{external_reference_id}\",\n    \"archive_previous_bundles\":True,\n    \"file_name\": \"{brokerId}_{dossierNr}_{contractNr}_{SEQ}_bundle.pdf\",\n    \"source\": \"sftp\",\n    \"channel_type\": \"broker\",\n    \"credit_type\": \"consumer\",\n    \"remote_signing\" : True,\n    \"signers\": [{\n          \"email\": \"xxx\",\n          \"first_name\": \"John\",\n          \"last_name\": \"Doe\",\n      \t\t\"street\": \"Rue de l' Etang\",\n      \t\t\"street_number\": \"5\",\n   \t      \"street_additionnal_information\":\"b\",\n    \t\t  \"zip_code\": \"1315\",\n          \"city\": \"Incourt\",\n\t\t\t\t\t\"country\":\"BE\",\n          \"role\": \"1\",\n          \"national_identification_number\": \"xxxx\",\n          \"gender\": \"M\",\n          \"language\": \"nl\",\n          \"mobile_phone_number\": \"32474998877\"\n      },{\n          \"email\": \"yyyy\",\n          \"first_name\": \"Agent\",\n          \"last_name\": \"Bond\",\n      \t\t\"street\": \"Rue de l' Etang\",\n      \t\t\"street_number\": \"5\",\n   \t      \"street_additionnal_information\":\"b\",\n    \t\t  \"zip_code\": \"1315\",\n          \"city\": \"Incourt\",\n\t\t\t\t\t\"country\":\"BE\",\n          \"role\": \"3\",\n          \"national_identification_number\": \"xxxx\",\n          \"gender\": \"F\",\n          \"language\": \"nl\",\n          \"mobile_phone_number\": \"32474998877\"\n      }]\n}"
                }
              }
            }
          }
        },
        "x-readme": {
          "code-samples": [
            {
              "code": "{\n    \"branch_external_reference\": \"4473635\",\n    \"reference\": \"E023442\",\n    \"external_reference_id\":\"30dd879c-ee2f-11db-8314-0800200c9a66\",\n    \"archive_previous_bundles\":True,\n    \"file_name\": \"313725_E098543_934301835987_01_bundle.pdf\",\n    \"source\": \"sftp\",\n    \"channel_type\": \"broker\",\n    \"credit_type\": \"consumer\",\n    \"remote_signing\" : True,\n    \"street\": \"Rue de l' Etang\",\n    \"street_number\": \"5\",\n    \"street_additionnal_information\":\"b\",\n    \"zip_code\": \"1315\",\n    \"city\": \"Incourt\",\n\t  \"country\":\"BE\",\n    \"signers\": [{\n          \"email\": \"xxx\",\n          \"first_name\": \"John\",\n          \"last_name\": \"Doe\",\n          \"role\": \"1\",\n          \"date_of_birth\": \"YYYY-MM-DD\",\n          \"national_identification_number\": \"xxxx\",\n          \"gender\": \"M\",\n          \"language\": \"nl\",\n          \"mobile_phone_number\": \"32474998877\",          \n          \"life_insurance_premium_financing_requested\":True,\n          \"life_insurance_premium_amount\":\"185.4\",\n      },{\n          \"email\": \"yyyy\",\n          \"first_name\": \"Agent\",\n          \"last_name\": \"Bond\",\n          \"role\": \"3\",\n          \"date_of_birth\": \"YYYY-MM-DD\",\n          \"national_identification_number\": \"xxxx\",\n          \"gender\": \"F\",\n          \"language\": \"nl\",\n          \"mobile_phone_number\": \"32474998877\",          \n          \"life_insurance_premium_financing_requested\":True,\n          \"life_insurance_premium_amount\":\"200.03\",\n      }]\n}",
              "language": "json",
              "name": ""
            }
          ],
          "samples-languages": [
            "json"
          ]
        },
        "summary": "Notify new bundle available"
      }
    }
  },
  "security": [],
  "x-readme": {}
}
```