Send Data Sets
You can transfer the following types of data sets to our endpoint:
Customer data set: Import a new customer after registration -> Customer
Company data set: Import a new company -> Company
Contract data set: Import a new contract after a customer signed a contract -> Contract
Key and Modified
Customer and contract objects as well as some sub-objects contain a key and a modified value.
Key
The key specified in the JSON in each case has the following function: It identifies the respective data part. The key is used, for example, to identify a customer in the context of the compliance data sets (webhooks). Therefore, it must be stored on their side for the respective data record. A key must be unique and may not be used more than once for a data record.
Depending on the data set, several keys may be required. If not all data sets (a customer, an attachment/event) on your side are connected with an identifier that could be entered as a key, it is possible to use the key in exemplary form:
PERS_67ce7e13-b7b3-4c43-b465-da172c2acac1
ATT_67ce7e13-b7b3-4c43-b465-da172c2acac1
It is important that the keys are never duplicated
Do not use special chars like % or spaces.
Modified
This timestamp in the form YYYY-MM-DDTHH:mm:ss (ISO 8601) is important for the respective record. It describes the last change and is essential for the history. It must always correspond to the status of the data record.
Update Datasets
To update already imported records, please update the modified timestamps and resubmit the whole dataset including the updated contents. Make sure to provide the right keys that were used before.
If KYC-relevant fields were changed, we will send a new KYC Link, that can be used by the customer or company to verify themself with the updated data. KYC-relevant fields are indicated in red in the description of the data sets (See: Customer Record and Company Record).
Last updated