Configuration

Delete Configuration

Allows to delete their configuration for their organization.

SecurityapiKey

Request

path Parameters

configurationId

required

string

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4

Responses

200

OK.

400

Bad Request.

delete/configurations/businesspartnercuration/{configurationId}

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
"name": "Client configuration.",
"version": 1,
"configuration": {"contextConfigurations": [{"context": {"country": {"shortName": "CH",
"value": "Switzerland"
}
},
"addressCurationLevelThreshold": "0.5",
"outputLanguageTechnicalKey": "DE",
"outputCharsets": [{"concept": "ADDRESS",
"charset": "LATIN"
}
],
"profile": "STANDARD",
"featuresOn": ["ENRICH_ADDRESS"
],
"featuresOff": ["ENRICH_ADDRESS"
],
"addressDataSources": {"primaryAddressDataSource": {"technicalKey": "HERE",
"threshold": "0.4"
},
"secondaryAddressDataSources": [{"technicalKey": "HERE",
"threshold": "0.4"
}
]
},
"numberSeparator": {"value": ","
},
"inputAddressConceptsIgnored": ["BUILDING"
]
}
],
"goldenRecordSettings": {"dataSources": [{"countryScope": {"shortName": "CH",
"value": "Switzerland"
},
"primaryDataSource": {"technicalKey": "BR_RF"
},
"secondaryDataSources": [{"technicalKey": "BR_RF"
}
],
"otherDataSources": [{"technicalKey": "BR_RF"
}
],
"unallowedDataSources": [{"technicalKey": "BR_RF"
}
]
}
]
}
},
"createdAt": "2024-12-21T01:35:25Z",
"modifiedAt": "76248934691294444",
"createdBy": "76248934691294444",
"transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
}

List Available Character Sets

Allows users to retrieve a list of all the available character sets that can be used for data curation.

SecurityapiKey

Request

query Parameters

page	integer <int32> Current page number. Example: page=10
pageSize	integer <int32> Number of items per page. Example: pageSize=10

Responses

200

get/outputcharsets/charactersets

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"numberOfPages": "10",
"page": "1",
"pageSize": "100",
"total": "67",
"values": [{"characterSet": {"name": "International",
"technicalKey": "INTERNATIONAL"
}
}
]
}

List Available Concepts

Allows users to retrieve a list of all the available concepts that can be used for data curation.

SecurityapiKey

Request

query Parameters

page	integer <int32> Current page number. Example: page=10
pageSize	integer <int32> Number of items per page. Example: pageSize=10

Responses

200

get/outputcharsets/concepts

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"numberOfPages": "10",
"page": "1",
"pageSize": "100",
"total": "67",
"values": [{"concept": "Address"
}
]
}

List Available Features

Allows users to retrieve a list of all the available features that can be used for data curation.

SecurityapiKey

Request

query Parameters

page	integer <int32> Current page number. Example: page=10
pageSize	integer <int32> Number of items per page. Example: pageSize=10

Responses

200

get/features

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"numberOfPages": "10",
"page": "1",
"pageSize": "100",
"total": "67",
"values": [{"feature": "ADDRESS_CORRECTION"
}
]
}

List Available Profiles

Allows users to retrieve a list of all the available Profiles with its features that can be used for data curation.

SecurityapiKey

Request

query Parameters

page	integer <int32> Current page number. Example: page=10
pageSize	integer <int32> Number of items per page. Example: pageSize=10

Responses

200

get/profiles

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"numberOfPages": "10",
"page": "1",
"pageSize": "100",
"total": "67",
"values": [{"features": ["ENABLE_FUZZY_ENRICHMENTS"
],
"profile": "BUSINESS_PARTNER_ONLY"
}
]
}

List User Configurations

Allows user to retrieve their configurations for their workspace.

SecurityapiKey

Request

query Parameters

defaultConfiguration	boolean Default: null Limit search to configurations with provided default flag value. If left empty, all configurations will be returned. Example: defaultConfiguration=true
limit	integer (Limit) Number of items per page. Maximum 100 items can be returned in one page. Example: limit=100
startAfter	string (StartAfter) Used to retrieve the next page of results. Example: startAfter=5712566172571652

Responses

200

Successful operation

get/configurations/businesspartnercuration

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"startAfter": "5712566172571652",
"nextStartAfter": "5712566172571652",
"total": "67",
"values": [{"id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
"name": "Client configuration.",
"createdAt": "2024-12-21T01:35:25Z",
"modifiedAt": "76248934691294444",
"createdBy": "76248934691294444"
}
]
}

Read Users Configuration

Allows users to retrieve their configuration for their organization.

SecurityapiKey

Request

path Parameters

configurationId

required

string

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4

Responses

200

Successful operation

get/configurations/businesspartnercuration/{configurationId}

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
"name": "Client configuration.",
"version": 1,
"configuration": {"contextConfigurations": [{"context": {"country": {"shortName": "CH",
"value": "Switzerland"
}
},
"addressCurationLevelThreshold": "0.5",
"outputLanguageTechnicalKey": "DE",
"outputCharsets": [{"concept": "ADDRESS",
"charset": "LATIN"
}
],
"profile": "STANDARD",
"featuresOn": ["ENRICH_ADDRESS"
],
"featuresOff": ["ENRICH_ADDRESS"
],
"addressDataSources": {"primaryAddressDataSource": {"technicalKey": "HERE",
"threshold": "0.4"
},
"secondaryAddressDataSources": [{"technicalKey": "HERE",
"threshold": "0.4"
}
]
},
"numberSeparator": {"value": ","
},
"inputAddressConceptsIgnored": ["BUILDING"
]
}
],
"goldenRecordSettings": {"dataSources": [{"countryScope": {"shortName": "CH",
"value": "Switzerland"
},
"primaryDataSource": {"technicalKey": "BR_RF"
},
"secondaryDataSources": [{"technicalKey": "BR_RF"
}
],
"otherDataSources": [{"technicalKey": "BR_RF"
}
],
"unallowedDataSources": [{"technicalKey": "BR_RF"
}
]
}
]
}
},
"createdAt": "2024-12-21T01:35:25Z",
"modifiedAt": "76248934691294444",
"createdBy": "76248934691294444",
"transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
}

Update Configuration

Allows users to update their configuration for their organization.

SecurityapiKey

Request

path Parameters

configurationId

required

string

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4

Request Body schema: application/json

	object (DataCurationConfiguration) Allows users to configure Data Curation settings.
name	string The name of the configuration. Example: "My configuration"

Responses

200

Configuration updated successful

400

Bad Request.

put/configurations/businesspartnercuration/{configurationId}

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"name": "My configuration",
"configuration": {"contextConfigurations": [{"context": {"country": {"shortName": "CH",
"value": "Switzerland"
}
},
"addressCurationLevelThreshold": "0.5",
"outputLanguageTechnicalKey": "DE",
"outputCharsets": [{"concept": "ADDRESS",
"charset": "LATIN"
}
],
"profile": "STANDARD",
"featuresOn": ["ENRICH_ADDRESS"
],
"featuresOff": ["ENRICH_ADDRESS"
],
"addressDataSources": {"primaryAddressDataSource": {"technicalKey": "HERE",
"threshold": "0.4"
},
"secondaryAddressDataSources": [{"technicalKey": "HERE",
"threshold": "0.4"
}
]
},
"numberSeparator": {"value": ","
},
"inputAddressConceptsIgnored": ["BUILDING"
]
}
],
"goldenRecordSettings": {"dataSources": [{"countryScope": {"shortName": "CH",
"value": "Switzerland"
},
"primaryDataSource": {"technicalKey": "BR_RF"
},
"secondaryDataSources": [{"technicalKey": "BR_RF"
}
],
"otherDataSources": [{"technicalKey": "BR_RF"
}
],
"unallowedDataSources": [{"technicalKey": "BR_RF"
}
]
}
]
}
}
}

Response samples

application/json

{"id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
"name": "Client configuration.",
"version": 1,
"configuration": {"contextConfigurations": [{"context": {"country": {"shortName": "CH",
"value": "Switzerland"
}
},
"addressCurationLevelThreshold": "0.5",
"outputLanguageTechnicalKey": "DE",
"outputCharsets": [{"concept": "ADDRESS",
"charset": "LATIN"
}
],
"profile": "STANDARD",
"featuresOn": ["ENRICH_ADDRESS"
],
"featuresOff": ["ENRICH_ADDRESS"
],
"addressDataSources": {"primaryAddressDataSource": {"technicalKey": "HERE",
"threshold": "0.4"
},
"secondaryAddressDataSources": [{"technicalKey": "HERE",
"threshold": "0.4"
}
]
},
"numberSeparator": {"value": ","
},
"inputAddressConceptsIgnored": ["BUILDING"
]
}
],
"goldenRecordSettings": {"dataSources": [{"countryScope": {"shortName": "CH",
"value": "Switzerland"
},
"primaryDataSource": {"technicalKey": "BR_RF"
},
"secondaryDataSources": [{"technicalKey": "BR_RF"
}
],
"otherDataSources": [{"technicalKey": "BR_RF"
}
],
"unallowedDataSources": [{"technicalKey": "BR_RF"
}
]
}
]
}
},
"createdAt": "2024-12-21T01:35:25Z",
"modifiedAt": "76248934691294444",
"createdBy": "76248934691294444",
"transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
}