Notify new bundle available

post

https://{{base_url}}/api/bundles

When a bundle requires signature, the partner uploads the related documents to a secure server (e.g. SFTP). This API call informs the platform that the documents are ready to be retrieved, processed, and included in the digital signing workflow.

Body Params

branch_external_reference

string

required

Partner branch or broker identifier. Example: 4473635

reference

string

required

Case reference used by the partner. Example: E023442

archive_previous_bundles

boolean

required

Defaults to false

Boolean flag indicating whether previous bundles for the same reference should be archived

file_name

string

required

Name of the PDF bundle file as provided by the partner. Example: {brokerId}{dossierNr}{contractNr}_{SEQ}_bundle.pdf = "313725_E098543_934301835987_01_bundle.pdf"

source

string

enum

required

Defaults to sftp

Source channel from which the bundle is provided

Allowed:

channel_type

string

enum

required

Business channel initiating the bundle

Allowed:

remote_signing

boolean

required

Indicates whether the bundle allows a remote digital signature flow

street

string

required

Street part of the address for the signature location

street_number

string

Street number part of the address for the signature location

street_additionnal_information

string

Additional information part of the address for the signature location

zip_code

string

required

Zip code part of the address for the signature location

country

string

required

Country part of the address for the signature location

signers

object

required

Responses

401

Unauthorized

500

Internal Server Error

Language

URL

Request

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully notified a new bundle available

400Bad request