Match

The API performs a single query similar to the batch function and is suitable for checking the status of a specific record for changes. The Match function also supports fuzzy logic with phonetic matching to compensate for inaccurate entries.

Match

The API searches all eligible sources based on the provided input data to determine the best possible result.

Result Interpretation:

• If a match is found in the History, it is identified as a move.

• The function uses advanced matching algorithms to ensure accuracy even with incomplete or slightly deviating inputs.

post

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

/match/Match

Authorizations

auth-key

auth-keystringRequired

API Key required for authorized endpoints

Query parameters

source_filterstringOptionalDefault: ""

criteria_filterstringOptionalDefault: ""

Body

application/jsontext/jsonapplication/*+json

sourceOriginstring · nullableOptional

matchPriostring · nullableOptional

dwhIdstring · nullableOptional

uidstring · nullableOptional

chnrstring · nullableOptional

beacinteger · int32 · nullableOptional

egidinteger · int32 · nullableOptional

postAddressIdinteger · int32 · nullableOptional

firstnamestring · nullableOptional

namestring · nullableOptional

streetstring · nullableOptional

houseNostring · nullableOptional

zipstring · nullableOptional

locationstring · nullableOptional

phonestring · nullableOptional

mobilestring · nullableOptional

birthdatestring · nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

beacstring · nullableOptional

recordTypestring · nullableOptional

matchRatinginteger · enumOptionalPossible values:

languagestring · nullableOptional

salutationstring · nullableOptional

acadTitelstring · nullableOptional

acadTitelLabelstring · nullableOptional

careof1string · nullableOptional

careOf2string · nullableOptional

streetAdditionalstring · nullableOptional

countryCodestring · nullableOptional

postBoxFlagboolean · nullableOptional

postBoxstring · nullableOptional

postBoxTextstring · nullableOptional

postBoxZipstring · nullableOptional

postBoxZip6string · nullableOptional

postBoxLocationstring · nullableOptional

addressLabel1string · nullableOptional

addressLabel2string · nullableOptional

addressLabel3string · nullableOptional

addressLabel4string · nullableOptional

addressLabel5string · nullableOptional

addressLabel6string · nullableOptional

letterSalutationstring · nullableOptional

dwhIdstring · nullableOptional

companynamestring · nullableOptional

companyname2string · nullableOptional

companyname3string · nullableOptional

firstnamestring · nullableOptional

namestring · nullableOptional

streetstring · nullableOptional

houseNumberstring · nullableOptional

zipstring · nullableOptional

zip6string · nullableOptional

locationstring · nullableOptional

post

/match/Match

HTTPcURLJavaScriptPython

POST /v2/match/Match HTTP/1.1
Host: api.multisource.ch
auth-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 267

{
  "sourceOrigin": "text",
  "matchPrio": "text",
  "dwhId": "text",
  "uid": "text",
  "chnr": "text",
  "beac": 1,
  "egid": 1,
  "postAddressId": 1,
  "firstname": "text",
  "name": "text",
  "street": "text",
  "houseNo": "text",
  "zip": "text",
  "location": "text",
  "phone": "text",
  "mobile": "text",
  "birthdate": "text"
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "beac": "text",
  "recordType": "text",
  "matchRating": "0 = NoRating",
  "language": "text",
  "salutation": "text",
  "acadTitel": "text",
  "acadTitelLabel": "text",
  "careof1": "text",
  "careOf2": "text",
  "streetAdditional": "text",
  "countryCode": "text",
  "postBoxFlag": true,
  "postBox": "text",
  "postBoxText": "text",
  "postBoxZip": "text",
  "postBoxZip6": "text",
  "postBoxLocation": "text",
  "addressLabel1": "text",
  "addressLabel2": "text",
  "addressLabel3": "text",
  "addressLabel4": "text",
  "addressLabel5": "text",
  "addressLabel6": "text",
  "letterSalutation": "text",
  "dwhId": "text",
  "companyname": "text",
  "companyname2": "text",
  "companyname3": "text",
  "firstname": "text",
  "name": "text",
  "street": "text",
  "houseNumber": "text",
  "zip": "text",
  "zip6": "text",
  "location": "text",
  "meta": {
    "updateAvailable": true,
    "criterias": [
      {
        "dwhCriteriaId": "text",
        "criteriaId": "text",
        "criteriaSort": 1,
        "criteriaDescription": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "criteriaGroupSort": 1,
        "criteriaGroupDescription": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "valueAvailable": true
      }
    ]
  }
}

Update

Updates the matching data based on the provided input values.

A match is automatically performed before the update.

post

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

/match/Update

Authorizations

auth-key

auth-keystringRequired

API Key required for authorized endpoints

Body

application/jsontext/jsonapplication/*+json

sourceOriginstring · nullableOptional

matchPriostring · nullableOptional

dwhIdstring · nullableOptional

uidstring · nullableOptional

chnrstring · nullableOptional

beacinteger · int32 · nullableOptional

egidinteger · int32 · nullableOptional

postAddressIdinteger · int32 · nullableOptional

firstnamestring · nullableOptional

namestring · nullableOptional

streetstring · nullableOptional

houseNostring · nullableOptional

zipstring · nullableOptional

locationstring · nullableOptional

phonestring · nullableOptional

mobilestring · nullableOptional

birthdatestring · nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

prioReferenceStatusstring · nullableOptional

beacstring · nullableOptional

recordTypestring · nullableOptional

matchRatinginteger · enumOptionalPossible values:

languagestring · nullableOptional

salutationstring · nullableOptional

acadTitelstring · nullableOptional

acadTitelLabelstring · nullableOptional

careof1string · nullableOptional

careOf2string · nullableOptional

streetAdditionalstring · nullableOptional

countryCodestring · nullableOptional

postBoxFlagboolean · nullableOptional

postBoxstring · nullableOptional

postBoxTextstring · nullableOptional

postBoxZipstring · nullableOptional

postBoxZip6string · nullableOptional

postBoxLocationstring · nullableOptional

addressLabel1string · nullableOptional

addressLabel2string · nullableOptional

addressLabel3string · nullableOptional

addressLabel4string · nullableOptional

addressLabel5string · nullableOptional

addressLabel6string · nullableOptional

letterSalutationstring · nullableOptional

dwhIdstring · nullableOptional

companynamestring · nullableOptional

companyname2string · nullableOptional

companyname3string · nullableOptional

firstnamestring · nullableOptional

namestring · nullableOptional

streetstring · nullableOptional

houseNumberstring · nullableOptional

zipstring · nullableOptional

zip6string · nullableOptional

locationstring · nullableOptional

post

/match/Update

HTTPcURLJavaScriptPython

POST /v2/match/Update HTTP/1.1
Host: api.multisource.ch
auth-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 267

{
  "sourceOrigin": "text",
  "matchPrio": "text",
  "dwhId": "text",
  "uid": "text",
  "chnr": "text",
  "beac": 1,
  "egid": 1,
  "postAddressId": 1,
  "firstname": "text",
  "name": "text",
  "street": "text",
  "houseNo": "text",
  "zip": "text",
  "location": "text",
  "phone": "text",
  "mobile": "text",
  "birthdate": "text"
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "prioReferenceStatus": "text",
  "beac": "text",
  "recordType": "text",
  "matchRating": "0 = NoRating",
  "language": "text",
  "salutation": "text",
  "acadTitel": "text",
  "acadTitelLabel": "text",
  "careof1": "text",
  "careOf2": "text",
  "streetAdditional": "text",
  "countryCode": "text",
  "postBoxFlag": true,
  "postBox": "text",
  "postBoxText": "text",
  "postBoxZip": "text",
  "postBoxZip6": "text",
  "postBoxLocation": "text",
  "addressLabel1": "text",
  "addressLabel2": "text",
  "addressLabel3": "text",
  "addressLabel4": "text",
  "addressLabel5": "text",
  "addressLabel6": "text",
  "letterSalutation": "text",
  "dwhId": "text",
  "companyname": "text",
  "companyname2": "text",
  "companyname3": "text",
  "firstname": "text",
  "name": "text",
  "street": "text",
  "houseNumber": "text",
  "zip": "text",
  "zip6": "text",
  "location": "text"
}

Enrich

Enhances the record based on the provided dwhid with eligible additional information. A match is automatically performed before the enrichment.

The Enrich function automatically updates all available criteria.

If you only need specific criteria from the full list, follow these steps:

1

Retrieve DWH ID

Use the Search/Match function to obtain the DWH ID of the entry.

2

Get Detailed Information

Use the Data/Detail function to retrieve all available information about the entry.

3

Check Meta Block

Verify if the desired criterion is included in the meta block.

4

Ensure Availability

If the required criterion (e.g., PE_PHONE) has the property valueAvailable = true, use the corresponding dwhCriteriaId.

5

Load Specific Criteria

Use the Data/CriteriasDetail function to fetch only the required criteria. The request body should contain a list of the desired dwhCriteriaId.

post

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

/match/Enrich

Authorizations

auth-key

auth-keystringRequired

API Key required for authorized endpoints

Body

application/jsontext/jsonapplication/*+json

sourceOriginstring · nullableOptional

matchPriostring · nullableOptional

dwhIdstring · nullableOptional

uidstring · nullableOptional

chnrstring · nullableOptional

beacinteger · int32 · nullableOptional

egidinteger · int32 · nullableOptional

postAddressIdinteger · int32 · nullableOptional

firstnamestring · nullableOptional

namestring · nullableOptional

streetstring · nullableOptional

houseNostring · nullableOptional

zipstring · nullableOptional

locationstring · nullableOptional

phonestring · nullableOptional

mobilestring · nullableOptional

birthdatestring · nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

dwhCriteriaIdstring · nullableOptional

criteriaIdstring · nullableOptional

criteriaSortinteger · int32Optional

criteriaGroupSortinteger · int32Optional

valuestring · nullableOptional

post

/match/Enrich

HTTPcURLJavaScriptPython

POST /v2/match/Enrich HTTP/1.1
Host: api.multisource.ch
auth-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 267

{
  "sourceOrigin": "text",
  "matchPrio": "text",
  "dwhId": "text",
  "uid": "text",
  "chnr": "text",
  "beac": 1,
  "egid": 1,
  "postAddressId": 1,
  "firstname": "text",
  "name": "text",
  "street": "text",
  "houseNo": "text",
  "zip": "text",
  "location": "text",
  "phone": "text",
  "mobile": "text",
  "birthdate": "text"
}

application/jsontext/jsonapplication/*+json

200

OK

[
  {
    "dwhCriteriaId": "text",
    "criteriaId": "text",
    "criteriaSort": 1,
    "criteriaDescription": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "criteriaGroupDescription": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "criteriaGroupSort": 1,
    "value": "text",
    "valueDescription": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
]