Configurations

Create fetch configuration

Create a new fetch configuration for the current user.

SecurityapiKey

Request

Request Body schema: application/json

required	object (FetchConfigurationModel) The configuration for the Business Partner fetch.
name required	string (ConfigurationName) Display name for a configuration. Example: "Client configuration."
workspaceId	string (WorkspaceId) Uniquely identifying ID of the workspace. Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"

Responses

200

Configuration created successfully

400

Bad Request.

post/configurations/businesspartnerfetch

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
"name": "Client configuration.",
"configuration": {"featuresOn": ["SHOW_RAW_DATA"
],
"featuresOff": ["SHOW_RAW_DATA"
],
"screeningMatchingThreshold": "0.8"
}
}

Response samples

application/json

{"id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
"name": "Client configuration.",
"configuration": {"featuresOn": ["SHOW_RAW_DATA"
],
"featuresOff": ["SHOW_RAW_DATA"
],
"screeningMatchingThreshold": "0.8"
},
"createdAt": "2024-11-21T16:00:46Z",
"modifiedAt": "2024-11-21T16:00:46Z",
"createdBy": "76248934691294444"
}

Delete fetch configuration

Delete a fetch configuration of the current user.

SecurityapiKey

Request

path Parameters

configurationId

required

string

ID of the configuration to read.

Example: 5f7b1b3e3b1865f7b1b3e3b1

Responses

200

OK.

400

Bad Request.

delete/configurations/businesspartnerfetch/{configurationId}

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
"name": "Client configuration.",
"configuration": {"featuresOn": ["SHOW_RAW_DATA"
],
"featuresOff": ["SHOW_RAW_DATA"
],
"screeningMatchingThreshold": "0.8"
},
"createdAt": "2024-11-21T16:00:46Z",
"modifiedAt": "2024-11-21T16:00:46Z",
"createdBy": "76248934691294444"
}

Delete Lookup Configuration

Delete a lookup configuration of the current user.

SecurityapiKey

Request

path Parameters

configurationId

required

string

ID of the configuration to read.

Example: 5f7b1b3e3b1865f7b1b3e3b1

Responses

200

OK.

400

Bad Request.

delete/configurations/businesspartnerlookup/{configurationId}

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
"name": "Client configuration.",
"configuration": {"limit": "10",
"startAfter": "5712566172571652",
"dataSources": ["VIES"
],
"matchingThreshold": "0.5",
"maxCandidates": "50",
"storagesDataSources": [{"storageId": "6479fd136811f0361e083211",
"dataSources": [{"id": "6479fd136811f0361e083211"
}
]
}
],
"featuresOn": ["ACTIVATE_DATASOURCE_BVD"
],
"featuresOff": ["ACTIVATE_DATASOURCE_BVD"
]
},
"createdAt": "2024-11-21T16:00:46Z",
"modifiedAt": "2024-11-21T16:00:46Z",
"createdBy": "76248934691294444"
}

List fetch configurations

List all fetch configurations of the current user.

SecurityapiKey

Request

query Parameters

defaultConfiguration	boolean Is default workspace configuration of given type. Example: defaultConfiguration=true
limit	integer (Limit) Maximum number of configurations to return. Used for pagination. Example: limit=100
startAfter	string (StartAfter) ID of the last configuration returned in the previous request. Used for pagination. Example: startAfter=5712566172571652

Responses

200

Successful operation

get/configurations/businesspartnerfetch

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-11-21T16:00:46Z",
"modifiedAt": "2024-11-21T16:00:46Z",
"createdBy": "76248934691294444"
}
]
}

List lookup configurations

List all lookup configurations of the current user.

SecurityapiKey

Request

query Parameters

defaultConfiguration	boolean Is default workspace configuration of given type. Example: defaultConfiguration=true
limit	integer (Limit) Maximum number of configurations to return. Used for pagination. Example: limit=100
startAfter	string (StartAfter) ID of the last configuration returned in the previous request. Used for pagination. Example: startAfter=5712566172571652

Responses

200

Successful operation

get/configurations/businesspartnerlookup

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-11-21T16:00:46Z",
"modifiedAt": "2024-11-21T16:00:46Z",
"createdBy": "76248934691294444"
}
]
}

Read fetch configuration

Read a fetch configuration of the current user.

SecurityapiKey

Request

path Parameters

configurationId

required

string

ID of the configuration to read.

Example: 5f7b1b3e3b1865f7b1b3e3b1

Responses

200

Successful operation

get/configurations/businesspartnerfetch/{configurationId}

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
"name": "Client configuration.",
"configuration": {"featuresOn": ["SHOW_RAW_DATA"
],
"featuresOff": ["SHOW_RAW_DATA"
],
"screeningMatchingThreshold": "0.8"
},
"createdAt": "2024-11-21T16:00:46Z",
"modifiedAt": "2024-11-21T16:00:46Z",
"createdBy": "76248934691294444"
}

Read Lookup Configuration

Read a lookup configuration of the current user.

SecurityapiKey

Request

path Parameters

configurationId

required

string

ID of the configuration to read.

Example: 5f7b1b3e3b1865f7b1b3e3b1

Responses

200

Successful operation

get/configurations/businesspartnerlookup/{configurationId}

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
"name": "Client configuration.",
"configuration": {"limit": "10",
"startAfter": "5712566172571652",
"dataSources": ["VIES"
],
"matchingThreshold": "0.5",
"maxCandidates": "50",
"storagesDataSources": [{"storageId": "6479fd136811f0361e083211",
"dataSources": [{"id": "6479fd136811f0361e083211"
}
]
}
],
"featuresOn": ["ACTIVATE_DATASOURCE_BVD"
],
"featuresOff": ["ACTIVATE_DATASOURCE_BVD"
]
},
"createdAt": "2024-11-21T16:00:46Z",
"modifiedAt": "2024-11-21T16:00:46Z",
"createdBy": "76248934691294444"
}

Update fetch configuration

Update a fetch configuration of the current user.

SecurityapiKey

Request

path Parameters

configurationId

required

string

ID of the configuration to read.

Example: 5f7b1b3e3b1865f7b1b3e3b1

Request Body schema: application/json

	object (FetchConfigurationModel) The configuration for the Business Partner fetch.
name	string (ConfigurationName) Display name for a configuration. Example: "Client configuration."

Responses

200

Configuration updated successful

400

Bad Request.

put/configurations/businesspartnerfetch/{configurationId}

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"name": "Client configuration.",
"configuration": {"featuresOn": ["SHOW_RAW_DATA"
],
"featuresOff": ["SHOW_RAW_DATA"
],
"screeningMatchingThreshold": "0.8"
}
}

Response samples

application/json

{"id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
"name": "Client configuration.",
"configuration": {"featuresOn": ["SHOW_RAW_DATA"
],
"featuresOff": ["SHOW_RAW_DATA"
],
"screeningMatchingThreshold": "0.8"
},
"createdAt": "2024-11-21T16:00:46Z",
"modifiedAt": "2024-11-21T16:00:46Z",
"createdBy": "76248934691294444"
}

Update Lookup Configuration

Update a lookup configuration of the current user.

SecurityapiKey

Request

path Parameters

configurationId

required

string

ID of the configuration to read.

Example: 5f7b1b3e3b1865f7b1b3e3b1

Request Body schema: application/json

	object (LookupConfigurationModel) Defines the configuration settings for a Business Partner lookup process.
name	string (ConfigurationName) Display name for a configuration. Example: "Client configuration."

Responses

200

Configuration updated successful

400

Bad Request.

put/configurations/businesspartnerlookup/{configurationId}

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"name": "Client configuration.",
"configuration": {"limit": "10",
"startAfter": "5712566172571652",
"dataSources": ["VIES"
],
"matchingThreshold": "0.5",
"maxCandidates": "50",
"storagesDataSources": [{"storageId": "6479fd136811f0361e083211",
"dataSources": [{"id": "6479fd136811f0361e083211"
}
]
}
],
"featuresOn": ["ACTIVATE_DATASOURCE_BVD"
],
"featuresOff": ["ACTIVATE_DATASOURCE_BVD"
]
}
}

Response samples

application/json

{"id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
"name": "Client configuration.",
"configuration": {"limit": "10",
"startAfter": "5712566172571652",
"dataSources": ["VIES"
],
"matchingThreshold": "0.5",
"maxCandidates": "50",
"storagesDataSources": [{"storageId": "6479fd136811f0361e083211",
"dataSources": [{"id": "6479fd136811f0361e083211"
}
]
}
],
"featuresOn": ["ACTIVATE_DATASOURCE_BVD"
],
"featuresOff": ["ACTIVATE_DATASOURCE_BVD"
]
},
"createdAt": "2024-11-21T16:00:46Z",
"modifiedAt": "2024-11-21T16:00:46Z",
"createdBy": "76248934691294444"
}