Party Management
Party
This API endpoint allows you to create a new party, which can be either a natural person or a legal entity.
POST
/
omni-omni
/
v1
/
parties
curl --request POST \
--url https://backend.sandbox.ecrop.de/ecrop-command/omni-omni/v1/parties \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"email": "<string>",
"legalParty": {
"businessSectors": [
"FIN_INST_BANK_CREDIT"
],
"companyName": "<string>",
"customersLocations": [
"<string>"
],
"customersPaymentTypes": [
"CASH"
],
"description": "<string>",
"legalFormType": "AKTIENGESELLSCHAFT",
"registeredAddress": {
"city": "<string>",
"countryIso2": "<string>",
"houseNo": "<string>",
"street": "<string>",
"zip": "<string>"
},
"registrationNumber": "<string>",
"statute": {
"content": "<string>",
"description": "<string>",
"fileExtension": "<string>",
"fileType": "PICTURE",
"title": "<string>"
},
"symbol": "<string>"
},
"naturalParty": {
"birthDate": "2023-12-25",
"firstName": "<string>",
"image": {
"content": "<string>",
"description": "<string>",
"fileExtension": "<string>",
"fileType": "PICTURE",
"title": "<string>"
},
"kyc": {
"caseId": "<string>",
"caseResult": [
{
"content": "<string>",
"description": "<string>",
"fileExtension": "<string>",
"fileType": "PICTURE",
"title": "<string>"
}
],
"kycProvider": "POSTIDENT",
"kycResult": "success"
},
"lastName": "<string>",
"links": [
{
"id": 123,
"insertDate": "2023-11-07T05:31:56Z",
"modifyDate": "2023-11-07T05:31:56Z",
"title": "<string>",
"url": "<string>"
}
],
"mobile": "<string>",
"nationality": "<string>",
"pepFlag": true,
"phoneNumber": "<string>",
"residentialAddress": {
"city": "<string>",
"countryIso2": "<string>",
"houseNo": "<string>",
"street": "<string>",
"zip": "<string>"
},
"salutation": "UNKNOWN"
},
"publicKey": "<string>"
}'
{
"email": "<string>",
"legalParty": {
"businessSectors": [
"FIN_INST_BANK_CREDIT"
],
"companyName": "<string>",
"customersLocations": [
"<string>"
],
"customersPaymentTypes": [
"CASH"
],
"description": "<string>",
"legalFormType": "AKTIENGESELLSCHAFT",
"registeredAddress": {
"city": "<string>",
"countryIso2": "<string>",
"houseNo": "<string>",
"street": "<string>",
"zip": "<string>"
},
"registrationNumber": "<string>",
"statute": {
"description": "<string>",
"fileType": "PICTURE",
"id": 123,
"title": "<string>",
"url": "<string>"
},
"symbol": "<string>"
},
"naturalParty": {
"birthDate": "2023-12-25",
"firstName": "<string>",
"image": {
"description": "<string>",
"fileType": "PICTURE",
"id": 123,
"title": "<string>",
"url": "<string>"
},
"kyc": {
"caseId": "<string>",
"caseResult": [
{
"description": "<string>",
"fileType": "PICTURE",
"id": 123,
"title": "<string>",
"url": "<string>"
}
],
"kycProvider": "POSTIDENT",
"kycResult": "success"
},
"lastName": "<string>",
"links": [
{
"id": 123,
"insertDate": "2023-11-07T05:31:56Z",
"modifyDate": "2023-11-07T05:31:56Z",
"title": "<string>",
"url": "<string>"
}
],
"mobile": "<string>",
"nationality": "<string>",
"pepFlag": true,
"phoneNumber": "<string>",
"residentialAddress": {
"city": "<string>",
"countryIso2": "<string>",
"houseNo": "<string>",
"street": "<string>",
"zip": "<string>"
},
"salutation": "UNKNOWN"
}
}
Additional Examples for Party creation
{
"email": "john.doe@example.com",
"publicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwDNqC/f\n... [Rest of Public Key] ...\n-----END PUBLIC KEY-----",
"naturalParty": {
"firstName": "John",
"lastName": "Doe",
"salutation": "MR",
"nationality": "DE",
"phoneNumber": "+49123456789",
"mobile": "+49987654321",
"residentialAddress": {
"countryIso2": "DE",
"city": "Berlin",
"street": "Example Street",
"houseNo": "123",
"zip": "12345"
},
"pepFlag": false,
"birthDate": "1990-01-15",
"kyc": {}, // KYC data will be handled separately
"links": [] // No social media links provided in this example
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
201 - application/json
Party is created
The response is of type object
.
curl --request POST \
--url https://backend.sandbox.ecrop.de/ecrop-command/omni-omni/v1/parties \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"email": "<string>",
"legalParty": {
"businessSectors": [
"FIN_INST_BANK_CREDIT"
],
"companyName": "<string>",
"customersLocations": [
"<string>"
],
"customersPaymentTypes": [
"CASH"
],
"description": "<string>",
"legalFormType": "AKTIENGESELLSCHAFT",
"registeredAddress": {
"city": "<string>",
"countryIso2": "<string>",
"houseNo": "<string>",
"street": "<string>",
"zip": "<string>"
},
"registrationNumber": "<string>",
"statute": {
"content": "<string>",
"description": "<string>",
"fileExtension": "<string>",
"fileType": "PICTURE",
"title": "<string>"
},
"symbol": "<string>"
},
"naturalParty": {
"birthDate": "2023-12-25",
"firstName": "<string>",
"image": {
"content": "<string>",
"description": "<string>",
"fileExtension": "<string>",
"fileType": "PICTURE",
"title": "<string>"
},
"kyc": {
"caseId": "<string>",
"caseResult": [
{
"content": "<string>",
"description": "<string>",
"fileExtension": "<string>",
"fileType": "PICTURE",
"title": "<string>"
}
],
"kycProvider": "POSTIDENT",
"kycResult": "success"
},
"lastName": "<string>",
"links": [
{
"id": 123,
"insertDate": "2023-11-07T05:31:56Z",
"modifyDate": "2023-11-07T05:31:56Z",
"title": "<string>",
"url": "<string>"
}
],
"mobile": "<string>",
"nationality": "<string>",
"pepFlag": true,
"phoneNumber": "<string>",
"residentialAddress": {
"city": "<string>",
"countryIso2": "<string>",
"houseNo": "<string>",
"street": "<string>",
"zip": "<string>"
},
"salutation": "UNKNOWN"
},
"publicKey": "<string>"
}'
{
"email": "<string>",
"legalParty": {
"businessSectors": [
"FIN_INST_BANK_CREDIT"
],
"companyName": "<string>",
"customersLocations": [
"<string>"
],
"customersPaymentTypes": [
"CASH"
],
"description": "<string>",
"legalFormType": "AKTIENGESELLSCHAFT",
"registeredAddress": {
"city": "<string>",
"countryIso2": "<string>",
"houseNo": "<string>",
"street": "<string>",
"zip": "<string>"
},
"registrationNumber": "<string>",
"statute": {
"description": "<string>",
"fileType": "PICTURE",
"id": 123,
"title": "<string>",
"url": "<string>"
},
"symbol": "<string>"
},
"naturalParty": {
"birthDate": "2023-12-25",
"firstName": "<string>",
"image": {
"description": "<string>",
"fileType": "PICTURE",
"id": 123,
"title": "<string>",
"url": "<string>"
},
"kyc": {
"caseId": "<string>",
"caseResult": [
{
"description": "<string>",
"fileType": "PICTURE",
"id": 123,
"title": "<string>",
"url": "<string>"
}
],
"kycProvider": "POSTIDENT",
"kycResult": "success"
},
"lastName": "<string>",
"links": [
{
"id": 123,
"insertDate": "2023-11-07T05:31:56Z",
"modifyDate": "2023-11-07T05:31:56Z",
"title": "<string>",
"url": "<string>"
}
],
"mobile": "<string>",
"nationality": "<string>",
"pepFlag": true,
"phoneNumber": "<string>",
"residentialAddress": {
"city": "<string>",
"countryIso2": "<string>",
"houseNo": "<string>",
"street": "<string>",
"zip": "<string>"
},
"salutation": "UNKNOWN"
}
}