Identity Management
Identity
This endpoint accepts a risk evaluation order for an identity. You submit identity data (including personal and legal information) along with a reference number and webhook URL. OmniEagle processes the data and asynchronously sends the risk evaluation result to the provided webhook URL. A 201 response indicates successful acceptance of the order. A 208 response indicates that the order has already been received (duplicate submission).
POST
/
omni-eagle
/
v1
/
identities
curl --request POST \
--url https://backend.dev.ecrop.de/ecrop-command/omni-eagle/v1/identities \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"identity": {
"fullLegalName": "<string>",
"IdentificationProvider": "POSTIDENT",
"legal": {
"beneficialOwnershipInfoList": [
{
"identity": {},
"ownershipType": "CEO",
"shareHolder": true,
"sharePercentage": 123
}
],
"businessOwnershipClarified": true,
"businessSectors": [
"FIN_INST_BANK_CREDIT"
],
"businessSectorsClarified": true,
"customersLocations": [
"<string>"
],
"customersPaymentTypes": [
"CASH"
],
"geographicalExposureClarified": true,
"legalFormType": "AKTIENGESELLSCHAFT",
"mainSector": "<string>",
"managementBoardClarified": true,
"ownershipDepth": 123,
"registeredAddress": {
"city": "<string>",
"countryIso2": "<string>",
"houseNo": "<string>",
"id": 123,
"insertDate": "2023-11-07T05:31:56Z",
"modifyDate": "2023-11-07T05:31:56Z",
"street": "<string>",
"zip": "<string>"
},
"registrationNumber": "<string>",
"sourceOfFunds": "CLEAR"
},
"monitoringPattern": {
"accountMonitoringDays": 123,
"id": 123,
"insertDate": "2023-11-07T05:31:56Z",
"largeAmountThreshold": 123,
"modifyDate": "2023-11-07T05:31:56Z",
"transactionMonitoringHours": 123
},
"natural": {
"contact": {
"email": "<string>",
"mobile": "<string>",
"phoneNumber": "<string>"
},
"dateOfBirth": "2024-01-01",
"identificationDocumentsImage": [
{
"content": "<string>",
"humanReadableDescription": "<string>",
"title": "<string>"
}
],
"nationality": "<string>",
"pepFlag": true,
"residentialAddress": {
"city": "<string>",
"countryIso2": "<string>",
"houseNo": "<string>",
"id": 123,
"insertDate": "2023-11-07T05:31:56Z",
"modifyDate": "2023-11-07T05:31:56Z",
"street": "<string>",
"zip": "<string>"
},
"responsiblePerson": true,
"sourceOfWealth": "CLEAR"
},
"uniqueIdentifierInClient": "<string>"
},
"referenceNumber": 5000000000,
"webHookUrl": "<string>"
}'
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
201
Risk evaluation order received successfully.
curl --request POST \
--url https://backend.dev.ecrop.de/ecrop-command/omni-eagle/v1/identities \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"identity": {
"fullLegalName": "<string>",
"IdentificationProvider": "POSTIDENT",
"legal": {
"beneficialOwnershipInfoList": [
{
"identity": {},
"ownershipType": "CEO",
"shareHolder": true,
"sharePercentage": 123
}
],
"businessOwnershipClarified": true,
"businessSectors": [
"FIN_INST_BANK_CREDIT"
],
"businessSectorsClarified": true,
"customersLocations": [
"<string>"
],
"customersPaymentTypes": [
"CASH"
],
"geographicalExposureClarified": true,
"legalFormType": "AKTIENGESELLSCHAFT",
"mainSector": "<string>",
"managementBoardClarified": true,
"ownershipDepth": 123,
"registeredAddress": {
"city": "<string>",
"countryIso2": "<string>",
"houseNo": "<string>",
"id": 123,
"insertDate": "2023-11-07T05:31:56Z",
"modifyDate": "2023-11-07T05:31:56Z",
"street": "<string>",
"zip": "<string>"
},
"registrationNumber": "<string>",
"sourceOfFunds": "CLEAR"
},
"monitoringPattern": {
"accountMonitoringDays": 123,
"id": 123,
"insertDate": "2023-11-07T05:31:56Z",
"largeAmountThreshold": 123,
"modifyDate": "2023-11-07T05:31:56Z",
"transactionMonitoringHours": 123
},
"natural": {
"contact": {
"email": "<string>",
"mobile": "<string>",
"phoneNumber": "<string>"
},
"dateOfBirth": "2024-01-01",
"identificationDocumentsImage": [
{
"content": "<string>",
"humanReadableDescription": "<string>",
"title": "<string>"
}
],
"nationality": "<string>",
"pepFlag": true,
"residentialAddress": {
"city": "<string>",
"countryIso2": "<string>",
"houseNo": "<string>",
"id": 123,
"insertDate": "2023-11-07T05:31:56Z",
"modifyDate": "2023-11-07T05:31:56Z",
"street": "<string>",
"zip": "<string>"
},
"responsiblePerson": true,
"sourceOfWealth": "CLEAR"
},
"uniqueIdentifierInClient": "<string>"
},
"referenceNumber": 5000000000,
"webHookUrl": "<string>"
}'