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
Required range:
1 <= x <= 9999999999Available options:
POSTIDENT, IDNOW, WEBID_SOLUTIONS, VERIMI, NECT_GMBH, ONFIDO, SIGNICAT, OTHER Available options:
POSTIDENT, IDNOW, WEBID_SOLUTIONS, VERIMI, NECT_GMBH, ONFIDO, SIGNICAT, OTHER Available options:
CEO, BOARD_MEMBER, SHAREHOLDER, RESPONSIBLE_PERSON Available options:
FIN_INST_BANK_CREDIT, FIN_INST_PAYMENT, FIN_INST_E_MONEY, FIN_INST_FUND_FIRM, NON_FIN_REAL_STATE, NON_FIN_PRECIOUS_METAL, NON_FIN_PRECIOUS_STONE, FIN_INST_ART_DEALER, NON_FIN_NOTARIES, NON_FIN_ACCOUNTANT, NON_FIN_AUDITORS, NON_FIN_TAX_ADVISORS, NON_FIN_TRUST, GAMBLE_CASINO, GAMBLE_ONLINE, GAMBLE_LOTTERY, LUXURY_GOODS, CASH_RESTAURANT, CASH_BAR, CASH_NIGHTCLUB, CASH_RETAIL, OTHER Available options:
CASH, CRYPTO_CURRENCY, CHECKS, DIGITAL_WALLETS, CREDIT_DEBIT_CARD, LETTER_OF_CREDIT, WIRED_TRANSFER, ELECTRONIC_FUNC_TRANSFER Available options:
AKTIENGESELLSCHAFT, GESELLSCHAFT_MIT_BESCHRANKTER_HAFTUNG, UNTERNEHMERGESELLSCHAFT, OFFENE_HANDELSGESELLSCHAFT, KOMMANDITGESELLSCHAFT, PARTNERSCHAFTSGESELLSCHAFT, EINZELUNTERNEHMEN, GENOSSENSCHAFTEN, STIFTUNGEN Available options:
CLEAR, UNCLEAR, VAGUE The date of birth of the user
Example:
"2024-01-01"
Available options:
CLEAR, UNCLEAR, VAGUE Response
201
_mintlify/placeholder
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>"
}'