Send Contract Record

After a customer signs a new contract, send the contract data set to Concedus to start the import process. The format and structure of the contract data is documented under Data Format. If the customer is not yet registered, he first has to complete the verification process. If the customer is already registered / after the verification is completed, we send you the result of the import request in the form of a compliance record. Depending on the result, you can take further action.

Contract import process

API Method

The transfer of contract records is based on the transfer of customer records. The only difference here is the JSON content and the endpoint. The customer is always assigned to a contract. If the customer has already been transferred in advance, only the customer key and the person key including modified are required in the customer object.

In the Demo-Environment the product "TestAnleihe" is activated by default. Please use this only.

Import contract

POST https://demo2.api.concedus.com/v2/compliance/contracts

Headers

Name	Type	Description
Content-Type*	String	application/zip or application/json
Authorization*	String	Bearer token

Request Body

Name	Type	Description
contracts*	json	See: JSON structure
attachments	pdf	Contract pdf

200: OK

{
  "identLinks": []
}

400: Bad Request

401: Unauthorized

Data Format

• ZIP must be sent if attachments are to be transferred as well. (default)

• JSON is transmitted when no other attachments are transmitted in file form.

Most products require a contract as PDF file, please ask our legal department if you are not sure if you don't need such a contract)

Only use valid filenames. Do not use special characters including "/".

Contract example

Customer already exists

{
    "contracts": [
        {
            "product": "TestAnleihe",
            "agio": 0.0,
            "agioDiscountAf": 0.0,
            "share": 6634,
            "origin": "V",
            "signed": "2022-04-04",
            "units": 322,
            "interestRate": 0.0,
            "customer": {
                "person": {
                    "key": "PERS_9399d213-7adf-4817-b7b5-5ef47637ac33",
                    "modified": "2023-03-27T16:25:01"
                },
                "key": "CUSTO_8f77a80f-5f4f-4682-81e2-39210a1a612a",
                "modified": "2023-03-27T16:25:01"
            },
            "events": [
                {
                    "date": "2023-03-23",
                    "subject": "Zeichnugsschein",
                    "category": "Zeichnungsschein",
                    "file": "contract0.pdf",
                    "public": true,
                    "key": "ATT_c1bb8442-9609-42d5-8a85-75f8ec68886c",
                    "modified": "2023-03-27T16:25:01"
                }
            ],
            "key": "CONTR_9cabef57-1250-44b7-9184-c17eed80b523",
            "modified": "2023-03-27T16:25:01"
        }
    ]
}

JSON structure

Contract

Field	Type	Requirement	Description
product	string	required	"TestAnleihe" (predefined)
agio	number	optional	Surcharge/fee that the customer must pay on top of the nominal price (not obligatory)
agioDiscountAf	number	optional	Discount that the customer receives on the nominal price (not obligatory)
share	number	required	Nominal value or share of the financial instrument always in EUR without the agio. This is the price of the contracts value and needs to match with the sum on the contract
origin	string	required	"P": primary market "V": secondary market
signed	string	required	DateTime when the contract is signed
units	number	optional	The number of shares or amount of shares
interestRate	number	optional	The interest of the financial instrument
customer	object	required	If customer is new, all data required (like customer) If customer already exists, only customer.key, customer.person.key and modified required
events	object	depends on legal requirements	See: Events
key	string	required	See: Key
modified	string	required	See: Modified

Events

Field	Type	Requirement	Description
date	string	required	DateTime when the file was created
subject	string	required	individual
category	string	required	default: "Contract"
file	string	required	relative file path in the zip file (if wrong or missing, import will fail)
key	string	required	See: Key
modified	string	required	See: Modified