Match

The API performs a single query similar to the Neartime 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
/Match/Match
Authorizations
AuthorizationstringRequired

Please enter a valid token

Body
sourceOriginstring | nullableOptional
matchPriostring | nullableOptional
dwhIdstring | nullableOptional
uidstring | nullableOptional
chnrstring | nullableOptional
beacinteger · int32Optional
egidinteger · int32Optional
postAddressIdinteger · int32Optional
firstnamestring | nullableOptional
namestring | nullableOptional
streetstring | nullableOptional
houseNostring | nullableOptional
zipstring | nullableOptional
locationstring | nullableOptional
phonestring | nullableOptional
mobilestring | nullableOptional
birthdatestring | nullableOptional
Responses
200

OK

post
/Match/Match
POST /v2/Match/Match HTTP/1.1
Host: api.multisource.ch
Authorization: Bearer YOUR_SECRET_TOKEN
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"
}
200

OK

{
  "companyname": "text",
  "firstname": "text",
  "name": "text",
  "street": "text",
  "houseNumber": "text",
  "zip": "text",
  "location": "text",
  "dwhId": "text",
  "beac": "text",
  "recordType": "text",
  "matchRating": 0,
  "language": "text",
  "salutation": "text",
  "acadTitel": "text",
  "acadTitelLabel": "text",
  "company2": "text",
  "company3": "text",
  "careof1": "text",
  "careOf2": "text",
  "streetAdditional": "text",
  "zip6": "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",
  "meta": {
    "updateAvailable": true,
    "criterias": [
      {
        "dwhCriteriaId": "text",
        "criteriaDescription": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "valueAvailable": true
      }
    ]
  }
}

MatchRating

Calculates the match rating.

It is used exclusively for specific use cases and defined within the scope of business analysis.

post
/Match/MatchRating
Authorizations
AuthorizationstringRequired

Please enter a valid token

Body
sourceOriginstring | nullableOptional
matchPriostring | nullableOptional
dwhIdstring | nullableOptional
uidstring | nullableOptional
chnrstring | nullableOptional
beacinteger · int32Optional
egidinteger · int32Optional
postAddressIdinteger · int32Optional
firstnamestring | nullableOptional
namestring | nullableOptional
streetstring | nullableOptional
houseNostring | nullableOptional
zipstring | nullableOptional
locationstring | nullableOptional
phonestring | nullableOptional
mobilestring | nullableOptional
birthdatestring | nullableOptional
Responses
200

OK

post
/Match/MatchRating
POST /v2/Match/MatchRating HTTP/1.1
Host: api.multisource.ch
Authorization: Bearer YOUR_SECRET_TOKEN
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"
}
200

OK

{
  "matchRating": 0
}

MatchScore

Calculates the match score.

It is used exclusively for specific use cases and defined within the scope of business analysis.

post
/Match/MatchScore
Authorizations
AuthorizationstringRequired

Please enter a valid token

Body
sourceOriginstring | nullableOptional
matchPriostring | nullableOptional
dwhIdstring | nullableOptional
uidstring | nullableOptional
chnrstring | nullableOptional
beacinteger · int32Optional
egidinteger · int32Optional
postAddressIdinteger · int32Optional
firstnamestring | nullableOptional
namestring | nullableOptional
streetstring | nullableOptional
houseNostring | nullableOptional
zipstring | nullableOptional
locationstring | nullableOptional
phonestring | nullableOptional
mobilestring | nullableOptional
birthdatestring | nullableOptional
Responses
200

OK

post
/Match/MatchScore
POST /v2/Match/MatchScore HTTP/1.1
Host: api.multisource.ch
Authorization: Bearer YOUR_SECRET_TOKEN
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"
}
200

OK

{
  "companyname": "text",
  "firstname": "text",
  "name": "text",
  "street": "text",
  "houseNumber": "text",
  "zip": "text",
  "location": "text",
  "dwhId": "text",
  "beac": "text",
  "recordType": "text",
  "matchRating": 0,
  "language": "text",
  "salutation": "text",
  "acadTitel": "text",
  "acadTitelLabel": "text",
  "company2": "text",
  "company3": "text",
  "careof1": "text",
  "careOf2": "text",
  "streetAdditional": "text",
  "zip6": "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",
  "meta": {
    "updateAvailable": true,
    "criterias": [
      {
        "dwhCriteriaId": "text",
        "criteriaDescription": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "valueAvailable": true
      }
    ]
  },
  "scoring": {
    "score": 1,
    "Name": 1,
    "Address": 1,
    "CompanyName": 1,
    "CompanyType": 1,
    "NameTotal": 1,
    "NameInitials": 1,
    "NameFirstname": 1,
    "NameLastname": 1,
    "EmployeeNameTotal": 1,
    "EmployeeInitials": 1,
    "EmployeeFirstname": 1,
    "EmployeeLastname": 1,
    "Zip": 1,
    "City": 1,
    "Street": 1,
    "Hnr": 1,
    "Phone": 1,
    "Email": 1,
    "Birthdate": 1,
    "Bankcode": 1,
    "AccountNr": 1,
    "Creditcard": 1,
    "F1": 1,
    "F2": 1,
    "F3": 1,
    "F4": 1,
    "F5": 1
  }
}

Update

Updates the matching data based on the provided input values.

A match is automatically performed before the update.

post
/Match/Update
Authorizations
AuthorizationstringRequired

Please enter a valid token

Body
sourceOriginstring | nullableOptional
matchPriostring | nullableOptional
dwhIdstring | nullableOptional
uidstring | nullableOptional
chnrstring | nullableOptional
beacinteger · int32Optional
egidinteger · int32Optional
postAddressIdinteger · int32Optional
firstnamestring | nullableOptional
namestring | nullableOptional
streetstring | nullableOptional
houseNostring | nullableOptional
zipstring | nullableOptional
locationstring | nullableOptional
phonestring | nullableOptional
mobilestring | nullableOptional
birthdatestring | nullableOptional
Responses
200

OK

post
/Match/Update
POST /v2/Match/Update HTTP/1.1
Host: api.multisource.ch
Authorization: Bearer YOUR_SECRET_TOKEN
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"
}
200

OK

{
  "companyname": "text",
  "firstname": "text",
  "name": "text",
  "street": "text",
  "houseNumber": "text",
  "zip": "text",
  "location": "text",
  "dwhId": "text",
  "beac": "text",
  "recordType": "text",
  "matchRating": 0,
  "language": "text",
  "salutation": "text",
  "acadTitel": "text",
  "acadTitelLabel": "text",
  "company2": "text",
  "company3": "text",
  "careof1": "text",
  "careOf2": "text",
  "streetAdditional": "text",
  "zip6": "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",
  "prioReferenceStatus": "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
/Match/Enrich
Authorizations
AuthorizationstringRequired

Please enter a valid token

Body
sourceOriginstring | nullableOptional
matchPriostring | nullableOptional
dwhIdstring | nullableOptional
uidstring | nullableOptional
chnrstring | nullableOptional
beacinteger · int32Optional
egidinteger · int32Optional
postAddressIdinteger · int32Optional
firstnamestring | nullableOptional
namestring | nullableOptional
streetstring | nullableOptional
houseNostring | nullableOptional
zipstring | nullableOptional
locationstring | nullableOptional
phonestring | nullableOptional
mobilestring | nullableOptional
birthdatestring | nullableOptional
Responses
200

OK

post
/Match/Enrich
POST /v2/Match/Enrich HTTP/1.1
Host: api.multisource.ch
Authorization: Bearer YOUR_SECRET_TOKEN
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"
}
200

OK

[
  {
    "dwhCriteriaId": "text",
    "criteriaId": "text",
    "criteriaDescription": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "value": "text",
    "valueDescription": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
]

Last updated