Validate & Update

Address Processing Workflow

The batch process consists of the following steps:

1

Create a Batch

2

Upload File and Start Batch

• Variant A – File upload

• Variant B – Add records

3

Start processing

4

Retrieve details

5

Download results

• Variant A – File download

• Variant B – Retrieve records

Functions

Create

A batch serves as the container that defines the processing frame. A new batch must be created for each address run.

Request-Parameter
orderNr	Custom reference number that can be assigned for the unique identification of an order, e.g., for later inquiries or clarifications.
dataGroupCode	Unique identification of the Data Group. → Generated during the creation of the Data Group (/dataGroups/create). Must be referenced here.
userDescription	Name of the campaign or batch.
processId	System-assigned ID for the process. → Default value: 400
processingDate	Defines when the batch should be started (e.g., create the batch today, process over the weekend).
businessCase	Defines the process flow based on predefined presets. → Default value: 0
product	Selection of the desired product, e.g.: 1 Enrich: Enrich existing data. 2 Reference: Only analyze the data against available data sources, no data changes → Result: Analysis report from multisource and, if applicable, from Swiss Post. 3 AddressUpdate: Update existing addresses.
notificationEmail	Email address for notifications. If no specific email address is provided, the default email address of the currently logged-in user will be used.

post

https://api.multisource.ch/v2https://api.multisource.chhttps://apitep.multisource.ch

/addressprocessing/Create

Authorizations

auth-key

auth-keystringRequired

API Key required for authorized endpoints

Body

application/jsontext/jsonapplication/*+json

orderNrstringRequired

dataGroupIdinteger · int32Optional

dataGroupCodestring · nullableOptional

userDescriptionstring · nullableRequired

processIdinteger · int32Required

businessCaseinteger · int32Optional

productinteger · enumRequiredPossible values:

notificationEmailstringOptional

processingDatestring · date-timeOptional

runParallelbooleanOptional

Responses

200

OK

text/plainapplication/jsontext/json

batchIdinteger · int32Optional

batchUniqueIdstring · uuidOptional

processGroupinteger · int32Optional

insertBystring · nullableOptional

insertAtstring · date-time · nullableOptional

descriptionstring · nullableOptional

userDescriptionstring · nullableOptional

statusstring · nullableOptional

startDatestring · date-time · nullableOptional

endDatestring · date-time · nullableOptional

processingDatestring · date-time · nullableOptional

durationinteger · int32 · nullableOptional

errorCountinteger · int32 · nullableOptional

warningCountinteger · int32 · nullableOptional

warningRejectCountinteger · int32 · nullableOptional

createTypeIdinteger · int32Optional

runSingleboolean · nullableOptional

agentstring · nullableOptional

datagroupIdinteger · int32 · nullableOptional

orderNrstring · nullableOptional

post

/addressprocessing/Create

HTTPcURLJavaScriptPython

POST /v2/addressprocessing/Create HTTP/1.1
Host: api.multisource.ch
auth-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 272

{
  "orderNr": "text",
  "dataGroupId": 1,
  "dataGroupCode": "text",
  "userDescription": "text",
  "processId": 1,
  "businessCase": 1,
  "product": "1 = Enrich",
  "notificationEmail": "text",
  "processingDate": "2026-02-20T18:57:31.033Z",
  "runParallel": true,
  "settings": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "batchId": 1,
  "batchUniqueId": "123e4567-e89b-12d3-a456-426614174000",
  "processGroup": 1,
  "insertBy": "text",
  "insertAt": "2026-02-20T18:57:31.033Z",
  "description": "text",
  "userDescription": "text",
  "status": "text",
  "startDate": "2026-02-20T18:57:31.033Z",
  "endDate": "2026-02-20T18:57:31.033Z",
  "processingDate": "2026-02-20T18:57:31.033Z",
  "duration": 1,
  "errorCount": 1,
  "warningCount": 1,
  "warningRejectCount": 1,
  "createTypeId": 1,
  "runSingle": true,
  "agent": "text",
  "datagroupId": 1,
  "orderNr": "text",
  "settings": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "files": [
    {
      "fileUniqueId": "123e4567-e89b-12d3-a456-426614174000",
      "direction": "text",
      "fileName": "text",
      "processFileDetection": "text",
      "description": "text"
    }
  ],
  "steps": [
    {
      "stepId": 1,
      "status": "text",
      "sortOrder": 1,
      "startDate": "2026-02-20T18:57:31.033Z",
      "endDate": "2026-02-20T18:57:31.033Z",
      "duration": 1,
      "errorCount": 1,
      "warningCount": 1,
      "warningRejectCount": 1,
      "recordCount": 1,
      "description": "text",
      "modulUniqueId": "123e4567-e89b-12d3-a456-426614174000",
      "descriptionAdd": "text"
    }
  ]
}

FileUpload

Adds a file for processing.

post

https://api.multisource.ch/v2https://api.multisource.chhttps://apitep.multisource.ch

/addressprocessing/FileUpload

Authorizations

auth-key

auth-keystringRequired

API Key required for authorized endpoints

Query parameters

batchIdinteger · int32Optional

batchUidstring · uuidOptional

descriptionstringOptional

Body

multipart/form-data

filestring · binaryOptional

Responses

200

OK

text/plainapplication/jsontext/json

stringOptional

post

/addressprocessing/FileUpload

HTTPcURLJavaScriptPython

POST /v2/addressprocessing/FileUpload HTTP/1.1
Host: api.multisource.ch
auth-key: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

200

OK

text

AddRecords

This function can be used to upload new records individually or to supplement an existing upload with additional records.

put

https://api.multisource.ch/v2https://api.multisource.chhttps://apitep.multisource.ch

/addressprocessing/AddRecords

Authorizations

auth-key

auth-keystringRequired

API Key required for authorized endpoints

Query parameters

idinteger · int32Optional

uidstring · uuidOptional

Bodyobject[]

application/jsontext/jsonapplication/*+json

customerIdstring · nullableOptional

classificationstring · nullableOptional

dwhIdstring · nullableOptional

kbbCompanyIdinteger · int32 · nullableOptional

kbcPersonIdinteger · int32 · nullableOptional

kbcHouseholdIdinteger · int32 · nullableOptional

beacinteger · int32 · nullableOptional

egidstring · nullableOptional

edidstring · nullableOptional

postAddressIdstring · nullableOptional

freetext1string · nullableOptional

freetext2string · nullableOptional

freetext3string · nullableOptional

freetext4string · nullableOptional

freetext5string · nullableOptional

firstnamestring · nullableOptional

companyNamestring · nullableOptional

namestring · nullableOptional

birthDatestring · nullableOptional

streetstring · nullableOptional

streetNostring · nullableOptional

streetAddstring · nullableOptional

careOfstring · nullableOptional

poBoxstring · nullableOptional

poZipstring · nullableOptional

poTownstring · nullableOptional

zipstring · nullableOptional

townstring · nullableOptional

mobileNostring · nullableOptional

phoneNostring · nullableOptional

emailstring · nullableOptional

uidstring · nullableOptional

chnrstring · nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

stringOptional

put

/addressprocessing/AddRecords

HTTPcURLJavaScriptPython

PUT /v2/addressprocessing/AddRecords HTTP/1.1
Host: api.multisource.ch
auth-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 561

[
  {
    "customerId": "text",
    "classification": "text",
    "dwhId": "text",
    "kbbCompanyId": 1,
    "kbcPersonId": 1,
    "kbcHouseholdId": 1,
    "beac": 1,
    "egid": "text",
    "edid": "text",
    "postAddressId": "text",
    "freetext1": "text",
    "freetext2": "text",
    "freetext3": "text",
    "freetext4": "text",
    "freetext5": "text",
    "firstname": "text",
    "companyName": "text",
    "name": "text",
    "birthDate": "text",
    "street": "text",
    "streetNo": "text",
    "streetAdd": "text",
    "careOf": "text",
    "poBox": "text",
    "poZip": "text",
    "poTown": "text",
    "zip": "text",
    "town": "text",
    "mobileNo": "text",
    "phoneNo": "text",
    "email": "text",
    "uid": "text",
    "chnr": "text"
  }
]

application/jsontext/jsonapplication/*+json

200

OK

text

Start

Starts the processing.

post

https://api.multisource.ch/v2https://api.multisource.chhttps://apitep.multisource.ch

/addressprocessing/Start

Authorizations

auth-key

auth-keystringRequired

API Key required for authorized endpoints

Query parameters

idinteger · int32Optional

uidstring · uuidOptional

Responses

200

OK

text/plainapplication/jsontext/json

stringOptional

post

/addressprocessing/Start

HTTPcURLJavaScriptPython

POST /v2/addressprocessing/Start HTTP/1.1
Host: api.multisource.ch
auth-key: YOUR_API_KEY
Accept: */*

200

OK

text

Detail

Provides an overview of all available files and their processing steps. It also includes the unique identification number (fileUniqueId) for each file.

Batch Status

Status ID	Name	Description
0	Created	Created, not yet processed
1	Execute	Queued; processing starts once resources are available
2	Processing	Processing in progress
3	Marked for processing	Intermediate state between Execute and Processing
4	Done	Successfully completed
6	Error	An error occurred during processing
8	Skipped	Certain modules were skipped

get

https://api.multisource.ch/v2https://api.multisource.chhttps://apitep.multisource.ch

/addressprocessing/Detail

Authorizations

auth-key

auth-keystringRequired

API Key required for authorized endpoints

Query parameters

idinteger · int32Optional

uidstring · uuidOptional

Responses

200

OK

text/plainapplication/jsontext/json

batchIdinteger · int32Optional

batchUniqueIdstring · uuidOptional

processGroupinteger · int32Optional

insertBystring · nullableOptional

insertAtstring · date-time · nullableOptional

descriptionstring · nullableOptional

userDescriptionstring · nullableOptional

statusstring · nullableOptional

startDatestring · date-time · nullableOptional

endDatestring · date-time · nullableOptional

processingDatestring · date-time · nullableOptional

durationinteger · int32 · nullableOptional

errorCountinteger · int32 · nullableOptional

warningCountinteger · int32 · nullableOptional

warningRejectCountinteger · int32 · nullableOptional

createTypeIdinteger · int32Optional

runSingleboolean · nullableOptional

agentstring · nullableOptional

datagroupIdinteger · int32 · nullableOptional

orderNrstring · nullableOptional

get

/addressprocessing/Detail

HTTPcURLJavaScriptPython

GET /v2/addressprocessing/Detail HTTP/1.1
Host: api.multisource.ch
auth-key: YOUR_API_KEY
Accept: */*

200

OK

{
  "batchId": 1,
  "batchUniqueId": "123e4567-e89b-12d3-a456-426614174000",
  "processGroup": 1,
  "insertBy": "text",
  "insertAt": "2026-02-20T18:57:31.033Z",
  "description": "text",
  "userDescription": "text",
  "status": "text",
  "startDate": "2026-02-20T18:57:31.033Z",
  "endDate": "2026-02-20T18:57:31.033Z",
  "processingDate": "2026-02-20T18:57:31.033Z",
  "duration": 1,
  "errorCount": 1,
  "warningCount": 1,
  "warningRejectCount": 1,
  "createTypeId": 1,
  "runSingle": true,
  "agent": "text",
  "datagroupId": 1,
  "orderNr": "text",
  "settings": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "files": [
    {
      "fileUniqueId": "123e4567-e89b-12d3-a456-426614174000",
      "direction": "text",
      "fileName": "text",
      "processFileDetection": "text",
      "description": "text"
    }
  ],
  "steps": [
    {
      "stepId": 1,
      "status": "text",
      "sortOrder": 1,
      "startDate": "2026-02-20T18:57:31.033Z",
      "endDate": "2026-02-20T18:57:31.033Z",
      "duration": 1,
      "errorCount": 1,
      "warningCount": 1,
      "warningRejectCount": 1,
      "recordCount": 1,
      "description": "text",
      "modulUniqueId": "123e4567-e89b-12d3-a456-426614174000",
      "descriptionAdd": "text"
    }
  ]
}

FileDownload

Downloads the results of an AdressProcessing batch as a file.

The output is provided in TSV format (tab-separated values).

The parameter compressed controls whether the file is delivered compressed (.txt.gz) (false) or uncompressed (.txt) (true).

get

https://api.multisource.ch/v2https://api.multisource.chhttps://apitep.multisource.ch

/addressprocessing/FileDownload

Authorizations

auth-key

auth-keystringRequired

API Key required for authorized endpoints

Query parameters

idinteger · int32Optional

uidstring · uuidOptional

decompressbooleanOptionalDefault: false

Responses

200

OK

No content

get

/addressprocessing/FileDownload

HTTPcURLJavaScriptPython

GET /v2/addressprocessing/FileDownload HTTP/1.1
Host: api.multisource.ch
auth-key: YOUR_API_KEY
Accept: */*

200

OK

No content

GetRecords

Retrieves the results of an AdressProcessing batch directly as JSON.

This endpoint is useful if the data should be processed directly within the system without downloading a file.

get

https://api.multisource.ch/v2https://api.multisource.chhttps://apitep.multisource.ch

/addressprocessing/GetRecords

Authorizations

auth-key

auth-keystringRequired

API Key required for authorized endpoints

Query parameters

uidstring · uuidOptional

filebooleanOptionalDefault: false

fileDecompressbooleanOptionalDefault: false

Responses

200

OK

No content

get

/addressprocessing/GetRecords

HTTPcURLJavaScriptPython

GET /v2/addressprocessing/GetRecords HTTP/1.1
Host: api.multisource.ch
auth-key: YOUR_API_KEY
Accept: */*

200

OK

No content

Optional Steps (for Advanced Use Cases)

AddDatagroup

Adds a data group.

Les données sont organisées en Data Groups. Celles-ci permettent, si nécessaire, de séparer logiquement les enregistrements. Vous pouvez ainsi traiter et analyser séparément, par exemple, les clients existants, les nouveaux clients ou les campagnes.

Dans de nombreux cas, une seule Data Group suffit : les données y sont simplement chargées et mises à jour en continu.

Remarque : Dès qu’une Data Group est lancée, les données existantes dans ce groupe sont remplacées.

put

https://api.multisource.ch/v2https://api.multisource.chhttps://apitep.multisource.ch

/addressprocessing/AddDatagroup

Authorizations

auth-key

auth-keystringRequired

API Key required for authorized endpoints

Query parameters

descriptionstringOptional

Responses

200

OK

No content

put

/addressprocessing/AddDatagroup

HTTPcURLJavaScriptPython

PUT /v2/addressprocessing/AddDatagroup HTTP/1.1
Host: api.multisource.ch
auth-key: YOUR_API_KEY
Accept: */*

200

OK

No content

GetDataGroups

Lists the available data groups.

get

https://api.multisource.ch/v2https://api.multisource.chhttps://apitep.multisource.ch

/addressprocessing/GetDatagroups

Authorizations

auth-key

auth-keystringRequired

API Key required for authorized endpoints

Responses

200

OK

No content

get

/addressprocessing/GetDatagroups

HTTPcURLJavaScriptPython

GET /v2/addressprocessing/GetDatagroups HTTP/1.1
Host: api.multisource.ch
auth-key: YOUR_API_KEY
Accept: */*

200

OK

No content

SetBatchSettings

Sets batch settings.

Request-Parameter

property-name

Setting values InputMapping Defines which data mapping will be applied to data processing. RangeBack For address changes to be considered (e.g., moves from the last 12 months). → Default value: 36 months. WebhookUrl For automation after the batch completion (currently only as a GET request with query string parameters). Can be used for further process automation to trigger actions for the customer after the batch completion (e.g., updating reports in PowerBI). webhookmethod Defines the HTTP method to be used for the call (e.g., POST or PUT). webhookheader Optional – defines the HTTP headers as a stringified JSON object, e.g. for passing authentication tokens. webhookbody Optional – defines the HTTP body as a stringified JSON object, e.g. for transmitting custom data or payloads.

post

https://api.multisource.ch/v2https://api.multisource.chhttps://apitep.multisource.ch

/addressprocessing/SetBatchSettings

Authorizations

auth-key

auth-keystringRequired

API Key required for authorized endpoints

Query parameters

uidstring · uuidOptional

Body

application/jsontext/jsonapplication/*+json

Other propertiesstringOptional

Responses

200

OK

text/plainapplication/jsontext/json

stringOptional

post

/addressprocessing/SetBatchSettings

HTTPcURLJavaScriptPython

POST /v2/addressprocessing/SetBatchSettings HTTP/1.1
Host: api.multisource.ch
auth-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "ANY_ADDITIONAL_PROPERTY": "text"
}

application/jsontext/jsonapplication/*+json

200

OK

text