Data

Once a record has been identified via Search or Match, detailed information about the record can be retrieved using the unique dwhid through the Data function.

Details

Retrieves detailed information for a specific dwhid.

This endpoint is used to fetch all available details about a particular record. It can be used for precise analysis or further processing of the data.

post
/Data/Details
Authorizations
auth-keystringRequired

API Key required for authorized endpoints

Bodystring[]
string[]Optional
Responses
chevron-right
200

OK

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
/Data/Details
200

OK

CriteriasDetail

Displays detailed information about specific criteria.

This endpoint provides a detailed description of the criteria used in various data contexts. It is useful for analyzing and managing data criteria.

post
/Data/CriteriasDetail
Authorizations
auth-keystringRequired

API Key required for authorized endpoints

Bodystring[]
string[]Optional
Responses
chevron-right
200

OK

dwhCriteriaIdstring · nullableOptional
criteriaIdstring · nullableOptional
criteriaSortinteger · int32Optional
criteriaGroupSortinteger · int32Optional
valuestring · nullableOptional
post
/Data/CriteriasDetail
200

OK

Relation

Retrieves information about data relationships.

This endpoint provides information about relationships between records or entities. It is ideal for analyzing dependencies and data linkages.

get
/Data/Relation
Authorizations
auth-keystringRequired

API Key required for authorized endpoints

Query parameters
relationDwhIdstringOptional
typeintegerOptional
languageintegerOptional
Responses
chevron-right
200

OK

idinteger · int64Optional
typeinteger · enumOptionalPossible values:
typeDescriptionstring · nullableOptional
valueCombinedstring · nullableOptional
value1stringOptional
value2stringOptional
value3stringOptional
relationIdinteger · int64Optional
relationDwhIdstringOptional
relationNamestringOptional
get
/Data/Relation
200

OK

UpdateCriteriaAvailable

Checks if new criteria are available that can be used for data updates.

This endpoint is used to determine if new or updated criteria are available for future data updates.

post
/Data/UpdateCriteriaAvailable
Authorizations
auth-keystringRequired

API Key required for authorized endpoints

Bodystring[]
string[]Optional
Responses
chevron-right
200

OK

Other propertiesstringOptional
post
/Data/UpdateCriteriaAvailable
200

OK

UpdatesAvailable

Checks if new data updates are available for retrieval.

This endpoint allows you to check if new or modified data is available since the last query. It enables efficient synchronization and updating of the data sets.

post
/Data/UpdatesAvailable
Authorizations
auth-keystringRequired

API Key required for authorized endpoints

Bodystring[]
string[]Optional
Responses
chevron-right
200

OK

Other propertiesstringOptional
post
/Data/UpdatesAvailable
200

OK

Last updated