# Partner Webhooks ## Customer Notification > Notification about customer changes related to event \`CUSTOMER\_NOTIFICATION\` ```json {"openapi":"3.0.1","info":{"title":"Partner Webhooks","version":"1.0"},"tags":[{"name":"Notifications","description":"Notifications"}],"servers":[{"url":"http://client-api-address"}],"paths":{"/customer-notification":{"post":{"summary":"Customer Notification","operationId":"customer-update","tags":["Notifications"],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}},"description":"Notification about customer changes related to event `CUSTOMER_NOTIFICATION`","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerNotification"}}}}}}},"components":{"schemas":{"ErrorMessage":{"title":"ErrorMessage","type":"object","properties":{"message":{"type":"string"},"responseType":{"type":"string"},"validationString":{"minLength":1,"type":"string"},"requestId":{"type":"string"},"errorCode":{"type":"string","maxLength":255},"errorDetails":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetails"}}},"required":["message","responseType","requestId"]},"ErrorDetails":{"title":"ErrorDetails","type":"object","properties":{"field":{"type":"string","maxLength":255},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetailsExplanation"}}},"required":["field"]},"ErrorDetailsExplanation":{"title":"ErrorDetailsExplanation","type":"object","properties":{"code":{"type":"string","maxLength":255},"parameter":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]},"CustomerNotification":{"title":"CustomerNotification","type":"object","properties":{"customerId":{"type":"string","format":"uuid"},"modifiedOn":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/CustomerStatusEnum"},"notificationType":{"$ref":"#/components/schemas/NotificationTypeEnum"},"validationError":{"$ref":"#/components/schemas/RoleValidationError"}},"required":["customerId","notificationType"]},"CustomerStatusEnum":{"title":"CustomerStatusEnum","type":"string","enum":["CREATED","REVIEW","REJECTED","INACTIVE","ACTIVE","SUSPENDED","ARCHIVED","RECEIVED","INVALID","PENDING","SUSPENDED_COMPLIANCE","ESTATE","OFFBOARDING"]},"NotificationTypeEnum":{"title":"NotificationTypeEnum","type":"string","enum":["CREATED","UPDATED","DELETED","VALIDATION_ERROR"]},"RoleValidationError":{"title":"RoleValidationError","type":"object","properties":{"errorType":{"$ref":"#/components/schemas/RoleValidationErrorEnum"},"description":{"type":"string"}},"required":["errorType","description"]},"RoleValidationErrorEnum":{"title":"RoleValidationErrorEnum","type":"string","enum":["ALREADY_EXISTS_ERROR","DATA_NOT_FOUND_ERROR","INAPPROPRIATE_DATA_STATUS_ERROR","INVALID_DATA_ERROR","CREATE_REJECTED_BY_ADMIN_ERROR","UPDATE_REJECTED_BY_ADMIN_ERROR","UNKNOWN_ERROR","DATA_MISSING_ERROR","INVALID_REF_ACCOUNT_IBAN","REF_ACCOUNT_IBAN_BIC_MISMATCH"]}}}} ``` ## Legal Entity Notification > Notification about legal entity changes related to event \`LEGAL\_ENTITY\_NOTIFICATION\` ```json {"openapi":"3.0.1","info":{"title":"Partner Webhooks","version":"1.0"},"tags":[{"name":"Notifications","description":"Notifications"}],"servers":[{"url":"http://client-api-address"}],"paths":{"/legal-entity-notification":{"post":{"summary":"Legal Entity Notification","operationId":"legal-entity-update","tags":["Notifications"],"responses":{"200":{"description":"OK"}},"description":"Notification about legal entity changes related to event `LEGAL_ENTITY_NOTIFICATION`","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalEntityNotification"}}}}}}},"components":{"schemas":{"LegalEntityNotification":{"title":"LegalEntityNotification","type":"object","properties":{"legalEntityId":{"type":"string","format":"uuid"},"modifiedOn":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/LegalEntityStatusEnum"},"notificationType":{"$ref":"#/components/schemas/NotificationTypeEnum"},"validationError":{"$ref":"#/components/schemas/EntityValidationError"}},"required":["legalEntityId","notificationType"]},"LegalEntityStatusEnum":{"title":"LegalEntityStatusEnum","type":"string","enum":["CREATED","REVIEW","REJECTED","INACTIVE","PENDING","ACTIVE","SUSPENDED","ARCHIVED","RECEIVED","INVALID","SUSPENDED_COMPLIANCE"]},"NotificationTypeEnum":{"title":"NotificationTypeEnum","type":"string","enum":["CREATED","UPDATED","DELETED","VALIDATION_ERROR"]},"EntityValidationError":{"title":"EntityValidationError","type":"object","properties":{"errorType":{"$ref":"#/components/schemas/EntityValidationErrorEnum"},"description":{"type":"string"}},"required":["errorType","description"]},"EntityValidationErrorEnum":{"title":"EntityValidationErrorEnum","type":"string","enum":["ALREADY_EXISTS_ERROR","DATA_MISSING_ERROR","DATA_NOT_FOUND_ERROR","EVENT_NOT_FOUND_ERROR","INAPPROPRIATE_DATA_STATUS_ERROR","INVALID_DATA_ERROR","CREATE_REJECTED_BY_ADMIN_ERROR","UPDATE_REJECTED_BY_ADMIN_ERROR","EMAIL_ALREADY_EXISTS_ERROR","INVALID_STATUS_UPDATE_ERROR","NATURAL_PERSON_NOT_FOUND_ERROR","NATURAL_PERSON_NOT_IN_CREATED_STATUS_ERROR","UNKNOWN_ERROR"]}}}} ``` ## Legal Representative Notification > Notification about legal representative changes related to event \`LEGAL\_REPRESENTATIVE\_NOTIFICATION\` ```json {"openapi":"3.0.1","info":{"title":"Partner Webhooks","version":"1.0"},"tags":[{"name":"Notifications","description":"Notifications"}],"servers":[{"url":"http://client-api-address"}],"paths":{"/legal-representative-notification":{"post":{"summary":"Legal Representative Notification","operationId":"legal-representative-update","tags":["Notifications"],"responses":{"200":{"description":"OK"}},"description":"Notification about legal representative changes related to event `LEGAL_REPRESENTATIVE_NOTIFICATION`","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalRepresentativeNotification"}}}}}}},"components":{"schemas":{"LegalRepresentativeNotification":{"title":"LegalRepresentativeNotification","type":"object","properties":{"legalRepresentativeId":{"type":"string","format":"uuid"},"modifiedOn":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/LegalRepresentativeStatusEnum"},"notificationType":{"$ref":"#/components/schemas/NotificationTypeEnum"},"validationError":{"$ref":"#/components/schemas/EntityValidationError"}},"required":["legalRepresentativeId","notificationType"]},"LegalRepresentativeStatusEnum":{"title":"LegalRepresentativeStatusEnum","type":"string","enum":["ACTIVE","INACTIVE","REVIEW","RECEIVED","INVALID"]},"NotificationTypeEnum":{"title":"NotificationTypeEnum","type":"string","enum":["CREATED","UPDATED","DELETED","VALIDATION_ERROR"]},"EntityValidationError":{"title":"EntityValidationError","type":"object","properties":{"errorType":{"$ref":"#/components/schemas/EntityValidationErrorEnum"},"description":{"type":"string"}},"required":["errorType","description"]},"EntityValidationErrorEnum":{"title":"EntityValidationErrorEnum","type":"string","enum":["ALREADY_EXISTS_ERROR","DATA_MISSING_ERROR","DATA_NOT_FOUND_ERROR","EVENT_NOT_FOUND_ERROR","INAPPROPRIATE_DATA_STATUS_ERROR","INVALID_DATA_ERROR","CREATE_REJECTED_BY_ADMIN_ERROR","UPDATE_REJECTED_BY_ADMIN_ERROR","EMAIL_ALREADY_EXISTS_ERROR","INVALID_STATUS_UPDATE_ERROR","NATURAL_PERSON_NOT_FOUND_ERROR","NATURAL_PERSON_NOT_IN_CREATED_STATUS_ERROR","UNKNOWN_ERROR"]}}}} ``` ## Corporate Action Notification > The endpoint is currently under development, and the structure may still change. Notification about corporate action update related to event \`CORPORATE\_ACTION\_NOTIFICATION\` ```json {"openapi":"3.0.1","info":{"title":"Partner Webhooks","version":"1.0"},"tags":[{"name":"Notifications","description":"Notifications"}],"servers":[{"url":"http://client-api-address"}],"paths":{"/corporate-action-notification":{"post":{"summary":"Corporate Action Notification","operationId":"corporate-action-notification","tags":["Notifications"],"responses":{"200":{"description":"OK","content":{}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorporateActionNotification"}}}},"description":"The endpoint is currently under development, and the structure may still change. Notification about corporate action update related to event `CORPORATE_ACTION_NOTIFICATION`"}}},"components":{"schemas":{"CorporateActionNotification":{"title":"CorporateActionNotification","type":"object","properties":{"type":{"$ref":"#/components/schemas/CorporateActionNotificationTypeEnum"},"eventId":{"type":"string","format":"uuid"},"caev":{"$ref":"#/components/schemas/CorporateActionEventTypeEnum"},"isin":{"type":"string"},"status":{"$ref":"#/components/schemas/CorporateActionEventStatusEnum"},"dates":{"$ref":"#/components/schemas/CorporateActionDates"},"details":{"$ref":"#/components/schemas/CorporateActionDetails"},"accounts":{"type":"array","items":{"$ref":"#/components/schemas/CorporateActionAccount"}},"metadata":{"$ref":"#/components/schemas/CorporateActionMetadata"},"validationError":{"$ref":"#/components/schemas/CorporateActionError"}},"required":["type","eventId","caev","isin","status","metadata"]},"CorporateActionNotificationTypeEnum":{"title":"CorporateActionNotificationTypeEnum","type":"string","description":"Corporate action notification type","enum":["CREATED","UPDATED","VALIDATION_ERROR"]},"CorporateActionEventTypeEnum":{"title":"CorporateActionEventTypeEnum","type":"string","description":"Corporate action event type","enum":["DVCA","INTR","REDM","BONU","SPLF","TEND","CHDV","EXRI","MEET","DVOP","LIQU","DVSE"]},"CorporateActionEventStatusEnum":{"title":"CorporateActionEventStatusEnum","type":"string","description":"Corporate action event status","enum":["ANNOUNCED","PENDING","SETTLED","REJECTED"]},"CorporateActionDates":{"title":"CorporateActionDates","type":"object","properties":{"exDate":{"type":"string","format":"date"},"payDate":{"type":"string","format":"date"},"effectiveDate":{"type":"string","format":"date"}}},"CorporateActionDetails":{"title":"CorporateActionDetails","type":"object","properties":{"ratioFrom":{"type":"number","format":"decimal","description":"Ratio From for SPLF/BONU corporate actions."},"grossAmountPerShare":{"type":"number"},"ratioTo":{"type":"number","format":"decimal","description":"Ratio To for SPLF/BONU corporate actions."}}},"CorporateActionAccount":{"title":"CorporateActionAccount","type":"object","properties":{"customerProductId":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"eligibleQuantity":{"type":"number"},"oldQuantity":{"type":"number"},"newQuantity":{"type":"number"},"ratioFrom":{"type":"number"},"ratioTo":{"type":"number"},"grossAmount":{"type":"number"},"netAmount":{"type":"number"},"submittedTenderedQuantity":{"type":"number"},"submittedCorporateActionOption":{"$ref":"#/components/schemas/CorporateActionTenderOptionEnum"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"}}},"CorporateActionTenderOptionEnum":{"title":"CorporateActionTenderOptionEnum","type":"string","description":"Corporate Action Tender Options","enum":["NONE","CASH","STOCK"]},"CurrencyEnum":{"title":"CurrencyEnum","type":"string","description":"Currency of the product's balance. Currency code in ISO 4217","enum":["EUR"]},"CorporateActionMetadata":{"title":"CorporateActionMetadata","type":"object","properties":{"summary":{"type":"string"}},"required":["summary"]},"CorporateActionError":{"title":"CorporateActionError","type":"object","properties":{"errorType":{"$ref":"#/components/schemas/CorporateActionNotificationErrorCodeEnum"},"description":{"type":"string"}},"required":["errorType","description"]},"CorporateActionNotificationErrorCodeEnum":{"title":"CorporateActionNotificationErrorCodeEnum","type":"string","enum":["CUSTOMER_PRODUCT_NOT_SUBJECTABLE_TO_CORPORATE_ACTION","RESPONSE_DEADLINE_EXCEEDED","OPTION_MISSMATCH_WITH_ANNOUNCED_OPTIONS","INSUFFICIENT_POSITION_TO_COVER_TENDERED_QUANTITY","TENDER_CANNOT_BE_SUBMITTED","MAXIMUM_QUANTITY_SHARES_EXCEEDED","MAXIMUM_CASH_AMOUNT_EXCEEDED"]}}}} ``` ## Natural Person Notification > Notification about natural person changes related to event \`NATURAL\_PERSON\_NOTIFICATION\` ```json {"openapi":"3.0.1","info":{"title":"Partner Webhooks","version":"1.0"},"tags":[{"name":"Notifications","description":"Notifications"}],"servers":[{"url":"http://client-api-address"}],"paths":{"/natural-person-notification":{"post":{"summary":"Natural Person Notification","operationId":"natural-person-update","tags":["Notifications"],"responses":{"200":{"description":"OK"}},"description":"Notification about natural person changes related to event `NATURAL_PERSON_NOTIFICATION`","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NaturalPersonNotification"}}}}}}},"components":{"schemas":{"NaturalPersonNotification":{"title":"NaturalPersonNotification","type":"object","properties":{"naturalPersonId":{"type":"string","format":"uuid"},"modifiedOn":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/NaturalPersonStatusEnum"},"notificationType":{"$ref":"#/components/schemas/NotificationTypeEnum"},"validationError":{"$ref":"#/components/schemas/EntityValidationError"}},"required":["naturalPersonId","notificationType"]},"NaturalPersonStatusEnum":{"title":"NaturalPersonStatusEnum","type":"string","enum":["CREATED","REVIEW","REJECTED","INACTIVE","PENDING","ACTIVE","SUSPENDED","ARCHIVED","RECEIVED","INVALID","SUSPENDED_COMPLIANCE","DECEASED"]},"NotificationTypeEnum":{"title":"NotificationTypeEnum","type":"string","enum":["CREATED","UPDATED","DELETED","VALIDATION_ERROR"]},"EntityValidationError":{"title":"EntityValidationError","type":"object","properties":{"errorType":{"$ref":"#/components/schemas/EntityValidationErrorEnum"},"description":{"type":"string"}},"required":["errorType","description"]},"EntityValidationErrorEnum":{"title":"EntityValidationErrorEnum","type":"string","enum":["ALREADY_EXISTS_ERROR","DATA_MISSING_ERROR","DATA_NOT_FOUND_ERROR","EVENT_NOT_FOUND_ERROR","INAPPROPRIATE_DATA_STATUS_ERROR","INVALID_DATA_ERROR","CREATE_REJECTED_BY_ADMIN_ERROR","UPDATE_REJECTED_BY_ADMIN_ERROR","EMAIL_ALREADY_EXISTS_ERROR","INVALID_STATUS_UPDATE_ERROR","NATURAL_PERSON_NOT_FOUND_ERROR","NATURAL_PERSON_NOT_IN_CREATED_STATUS_ERROR","UNKNOWN_ERROR"]}}}} ``` ## Joint Person Notification > Notification about joint person changes related to event \`JOINT\_PERSON\_NOTIFICATION\` ```json {"openapi":"3.0.1","info":{"title":"Partner Webhooks","version":"1.0"},"tags":[{"name":"Notifications","description":"Notifications"}],"servers":[{"url":"http://client-api-address"}],"paths":{"/joint-person-notification":{"post":{"summary":"Joint Person Notification","operationId":"joint-person-update","tags":["Notifications"],"responses":{"200":{"description":"OK"}},"description":"Notification about joint person changes related to event `JOINT_PERSON_NOTIFICATION`","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JointPersonNotification"}}}}}}},"components":{"schemas":{"JointPersonNotification":{"title":"JointPersonNotification","type":"object","properties":{"jointPersonId":{"type":"string","format":"uuid"},"modifiedOn":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/JointPersonStatusEnum"},"notificationType":{"$ref":"#/components/schemas/NotificationTypeEnum"},"validationError":{"$ref":"#/components/schemas/EntityValidationError"}},"required":["jointPersonId","notificationType"]},"JointPersonStatusEnum":{"title":"JointPersonStatusEnum","type":"string","enum":["CREATED","REVIEW","REJECTED","INACTIVE","PENDING","ACTIVE","SUSPENDED","ARCHIVED","RECEIVED","INVALID","SUSPENDED_COMPLIANCE"]},"NotificationTypeEnum":{"title":"NotificationTypeEnum","type":"string","enum":["CREATED","UPDATED","DELETED","VALIDATION_ERROR"]},"EntityValidationError":{"title":"EntityValidationError","type":"object","properties":{"errorType":{"$ref":"#/components/schemas/EntityValidationErrorEnum"},"description":{"type":"string"}},"required":["errorType","description"]},"EntityValidationErrorEnum":{"title":"EntityValidationErrorEnum","type":"string","enum":["ALREADY_EXISTS_ERROR","DATA_MISSING_ERROR","DATA_NOT_FOUND_ERROR","EVENT_NOT_FOUND_ERROR","INAPPROPRIATE_DATA_STATUS_ERROR","INVALID_DATA_ERROR","CREATE_REJECTED_BY_ADMIN_ERROR","UPDATE_REJECTED_BY_ADMIN_ERROR","EMAIL_ALREADY_EXISTS_ERROR","INVALID_STATUS_UPDATE_ERROR","NATURAL_PERSON_NOT_FOUND_ERROR","NATURAL_PERSON_NOT_IN_CREATED_STATUS_ERROR","UNKNOWN_ERROR"]}}}} ``` ## Identification Verification Notification > Notification about identification verification changes related to event \`IDENTIFICATION\_VERIFICATION\_NOTIFICATION\` ```json {"openapi":"3.0.1","info":{"title":"Partner Webhooks","version":"1.0"},"tags":[{"name":"Notifications","description":"Notifications"}],"servers":[{"url":"http://client-api-address"}],"paths":{"/identification-verification-notification":{"post":{"summary":"Identification Verification Notification","operationId":"identification-verification-update","tags":["Notifications"],"responses":{"200":{"description":"OK"}},"description":"Notification about identification verification changes related to event `IDENTIFICATION_VERIFICATION_NOTIFICATION`","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentificationVerificationNotification"}}}}}}},"components":{"schemas":{"IdentificationVerificationNotification":{"title":"IdentificationVerificationNotification","type":"object","properties":{"identificationVerificationId":{"type":"string","format":"uuid"},"naturalPersonId":{"type":"string","format":"uuid"},"modifiedOn":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/IdentificationVerificationStatusEnum"},"notificationType":{"$ref":"#/components/schemas/NotificationTypeEnum"},"validationError":{"$ref":"#/components/schemas/EntityValidationError"}},"required":["identificationVerificationId","naturalPersonId","modifiedOn","status","notificationType"]},"IdentificationVerificationStatusEnum":{"title":"IdentificationVerificationStatusEnum","type":"string","enum":["RECEIVED","INVALID","PENDING","APPROVED","REJECTED","EXPIRED"]},"NotificationTypeEnum":{"title":"NotificationTypeEnum","type":"string","enum":["CREATED","UPDATED","DELETED","VALIDATION_ERROR"]},"EntityValidationError":{"title":"EntityValidationError","type":"object","properties":{"errorType":{"$ref":"#/components/schemas/EntityValidationErrorEnum"},"description":{"type":"string"}},"required":["errorType","description"]},"EntityValidationErrorEnum":{"title":"EntityValidationErrorEnum","type":"string","enum":["ALREADY_EXISTS_ERROR","DATA_MISSING_ERROR","DATA_NOT_FOUND_ERROR","EVENT_NOT_FOUND_ERROR","INAPPROPRIATE_DATA_STATUS_ERROR","INVALID_DATA_ERROR","CREATE_REJECTED_BY_ADMIN_ERROR","UPDATE_REJECTED_BY_ADMIN_ERROR","EMAIL_ALREADY_EXISTS_ERROR","INVALID_STATUS_UPDATE_ERROR","NATURAL_PERSON_NOT_FOUND_ERROR","NATURAL_PERSON_NOT_IN_CREATED_STATUS_ERROR","UNKNOWN_ERROR"]}}}} ``` ## Labels Update Notification > Notification about labels updates related to event \`LABELS\_UPDATE\_NOTIFICATION\` ```json {"openapi":"3.0.1","info":{"title":"Partner Webhooks","version":"1.0"},"tags":[{"name":"Notifications","description":"Notifications"}],"servers":[{"url":"http://client-api-address"}],"paths":{"/labels-update-notification":{"post":{"summary":"Labels Update Notification","operationId":"labels-update","tags":["Notifications"],"responses":{"200":{"description":"OK"}},"description":"Notification about labels updates related to event `LABELS_UPDATE_NOTIFICATION`","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabelsUpdateNotification"}}}}}}},"components":{"schemas":{"LabelsUpdateNotification":{"title":"LabelsUpdateNotification","type":"object","properties":{"updatedCustomers":{"type":"array","items":{"type":"string","format":"uuid"}},"notificationType":{"$ref":"#/components/schemas/NotificationTypeEnum"},"validationError":{"$ref":"#/components/schemas/LabelsUpdateValidationError"}},"required":["modifiedOn","notificationType"]},"NotificationTypeEnum":{"title":"NotificationTypeEnum","type":"string","enum":["CREATED","UPDATED","DELETED","VALIDATION_ERROR"]},"LabelsUpdateValidationError":{"title":"LabelsUpdateValidationError","type":"object","properties":{"errorType":{"$ref":"#/components/schemas/LabelsUpdateValidationErrorEnum"},"description":{"type":"string"}},"required":["errorType","description"]},"LabelsUpdateValidationErrorEnum":{"title":"LabelsUpdateValidationErrorEnum","type":"string","enum":["CUSTOMERS_NOT_FOUND_ERROR","CUSTOMERS_EXCEEDED_LIMIT_OF_LABELS_ERROR","LABEL_NOT_FOUND_ERROR","UNKNOWN_ERROR"]}}}} ``` ## Onboarding Notification > Notification about onboarding update related to event \`ONBOARDING\_NOTIFICATION\` ```json {"openapi":"3.0.1","info":{"title":"Partner Webhooks","version":"1.0"},"tags":[{"name":"Notifications","description":"Notifications"}],"servers":[{"url":"http://client-api-address"}],"paths":{"/onboarding-notification":{"post":{"summary":"Onboarding Notification","operationId":"onboarding-notification","tags":["Notifications"],"responses":{"200":{"description":"OK","content":{}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnboardingNotification"}}}},"description":"Notification about onboarding update related to event `ONBOARDING_NOTIFICATION`"}}},"components":{"schemas":{"OnboardingNotification":{"title":"OnboardingNotification","type":"object","properties":{"onboardingId":{"type":"string","format":"uuid"},"modifiedOn":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/OnboardingStatusEnum"},"notificationType":{"$ref":"#/components/schemas/OnboardingNotificationTypeEnum"},"validationErrors":{"type":"array","items":{"$ref":"#/components/schemas/OnboardingValidationError"}}},"required":["onboardingId","modifiedOn","status","notificationType"]},"OnboardingStatusEnum":{"title":"OnboardingStatusEnum","type":"string","enum":["CREATED","PENDING","APPROVED","REJECTED","RECEIVED","INVALID"]},"OnboardingNotificationTypeEnum":{"title":"NotificationTypeEnum","type":"string","enum":["STARTED","REJECTED","INVALID","PENDING","APPROVED"]},"OnboardingValidationError":{"title":"OnboardingValidationError","type":"object","properties":{"errorType":{"$ref":"#/components/schemas/OnboardingValidationErrorEnum"},"description":{"type":"string"}},"required":["errorType","description"]},"OnboardingValidationErrorEnum":{"title":"OnboardingValidationErrorEnum","type":"string","enum":["CUSTOMER_STATUS_VERIFICATION","NATURAL_PERSON_STATUS_VERIFICATION","CUSTOMER_TYPE_VERIFICATION","DEATH_DAY_VERIFICATION","CONTACT_DATA_VERIFICATION","ADDRESS_VERIFICATION","CITIZENSHIP_VERIFICATION","VERIFIED_NATURAL_PERSON_VERIFICATION","DOCUMENT_VERIFICATION","DOCUMENT_SIGNATURES_VERIFICATION","CHILD_VERIFICATION","REFERENCE_ACCOUNTS_VERIFICATION","NACE_SECTORS_VERIFICATION","LEGAL_REPRESENTATIVES_VERIFICATION","BENEFICIAL_OWNERS_VERIFICATION","PROXIES_VERIFICATION","REFERENCE_ACCOUNTS_IBAN_VERIFICATION","LEGAL_ENTITY_VENDOR_VERIFICATION","JOINT_PERSON_THE_SAME_NATURAL_PERSON_IDS_VERIFICATION","JOINT_PERSON_ALREADY_EXISTS_VERIFICATION","JOINT_PERSON_NATURAL_PERSON_STATUS_VERIFICATION"]}}}} ``` ## Proxy Notification > Notification about proxy update related to event \`PROXY\_NOTIFICATION\` ```json {"openapi":"3.0.1","info":{"title":"Partner Webhooks","version":"1.0"},"tags":[{"name":"Notifications","description":"Notifications"}],"servers":[{"url":"http://client-api-address"}],"paths":{"/proxy-notification":{"post":{"summary":"Proxy Notification","operationId":"proxy-notification","tags":["Notifications"],"responses":{"200":{"description":"OK","content":{}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyNotification"}}}},"description":"Notification about proxy update related to event `PROXY_NOTIFICATION`"}}},"components":{"schemas":{"ProxyNotification":{"title":"ProxyNotification","type":"object","properties":{"proxyId":{"type":"string","format":"uuid"},"modifiedOn":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/ProxyStatusEnum"},"notificationType":{"$ref":"#/components/schemas/NotificationTypeEnum"},"validationError":{"$ref":"#/components/schemas/RoleValidationError"}},"required":["proxyId","notificationType"]},"ProxyStatusEnum":{"title":"ProxyStatusEnum","type":"string","enum":["CREATED","REVIEW","REJECTED","ACTIVE","INACTIVE","RECEIVED","INVALID","PENDING","SUSPENDED","SUSPENDED_COMPLIANCE"]},"NotificationTypeEnum":{"title":"NotificationTypeEnum","type":"string","enum":["CREATED","UPDATED","DELETED","VALIDATION_ERROR"]},"RoleValidationError":{"title":"RoleValidationError","type":"object","properties":{"errorType":{"$ref":"#/components/schemas/RoleValidationErrorEnum"},"description":{"type":"string"}},"required":["errorType","description"]},"RoleValidationErrorEnum":{"title":"RoleValidationErrorEnum","type":"string","enum":["ALREADY_EXISTS_ERROR","DATA_NOT_FOUND_ERROR","INAPPROPRIATE_DATA_STATUS_ERROR","INVALID_DATA_ERROR","CREATE_REJECTED_BY_ADMIN_ERROR","UPDATE_REJECTED_BY_ADMIN_ERROR","UNKNOWN_ERROR","DATA_MISSING_ERROR","INVALID_REF_ACCOUNT_IBAN","REF_ACCOUNT_IBAN_BIC_MISMATCH"]}}}} ``` ## Beneficial Owner Notification > Notification about beneficial owner update related to event \`BENEFICIAL\_OWNER\_NOTIFICATION\` ```json {"openapi":"3.0.1","info":{"title":"Partner Webhooks","version":"1.0"},"tags":[{"name":"Notifications","description":"Notifications"}],"servers":[{"url":"http://client-api-address"}],"paths":{"/beneficial-owner-notification":{"post":{"summary":"Beneficial Owner Notification","operationId":"beneficial-owner-notification","tags":["Notifications"],"responses":{"200":{"description":"OK","content":{}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeneficialOwnerNotification"}}}},"description":"Notification about beneficial owner update related to event `BENEFICIAL_OWNER_NOTIFICATION`"}}},"components":{"schemas":{"BeneficialOwnerNotification":{"title":"BeneficialOwnerNotification","type":"object","properties":{"beneficialOwnerId":{"type":"string","format":"uuid"},"modifiedOn":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/BeneficialOwnerStatusEnum"},"notificationType":{"$ref":"#/components/schemas/NotificationTypeEnum"},"validationError":{"$ref":"#/components/schemas/EntityValidationError"}},"required":["beneficialOwnerId","notificationType"]},"BeneficialOwnerStatusEnum":{"title":"BeneficialOwnerStatusEnum","type":"string","enum":["CREATED","ACTIVE","INACTIVE","RECEIVED","INVALID","REJECTED","REVIEW","PENDING","SUSPENDED_COMPLIANCE"]},"NotificationTypeEnum":{"title":"NotificationTypeEnum","type":"string","enum":["CREATED","UPDATED","DELETED","VALIDATION_ERROR"]},"EntityValidationError":{"title":"EntityValidationError","type":"object","properties":{"errorType":{"$ref":"#/components/schemas/EntityValidationErrorEnum"},"description":{"type":"string"}},"required":["errorType","description"]},"EntityValidationErrorEnum":{"title":"EntityValidationErrorEnum","type":"string","enum":["ALREADY_EXISTS_ERROR","DATA_MISSING_ERROR","DATA_NOT_FOUND_ERROR","EVENT_NOT_FOUND_ERROR","INAPPROPRIATE_DATA_STATUS_ERROR","INVALID_DATA_ERROR","CREATE_REJECTED_BY_ADMIN_ERROR","UPDATE_REJECTED_BY_ADMIN_ERROR","EMAIL_ALREADY_EXISTS_ERROR","INVALID_STATUS_UPDATE_ERROR","NATURAL_PERSON_NOT_FOUND_ERROR","NATURAL_PERSON_NOT_IN_CREATED_STATUS_ERROR","UNKNOWN_ERROR"]}}}} ``` ## Partner Document Notification > Notification about partner document update related to event \`PARTNER\_DOCUMENT\_NOTIFICATION\` ```json {"openapi":"3.0.1","info":{"title":"Partner Webhooks","version":"1.0"},"tags":[{"name":"Notifications","description":"Notifications"}],"servers":[{"url":"http://client-api-address"}],"paths":{"/partner-document-notification":{"post":{"summary":"Partner Document Notification","operationId":"partner-document-notification","tags":["Notifications"],"responses":{"200":{"description":"OK"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerDocumentNotification"}}}},"description":"Notification about partner document update related to event `PARTNER_DOCUMENT_NOTIFICATION`"}}},"components":{"schemas":{"PartnerDocumentNotification":{"title":"PartnerDocumentNotification","type":"object","properties":{"documentId":{"type":"string","format":"uuid"},"modifiedOn":{"type":"string","format":"date-time"}},"required":["documentId","modifiedOn"]}}}} ``` ## Document Notification > Notification about document update related to event \`DOCUMENT\_NOTIFICATION\` ```json {"openapi":"3.0.1","info":{"title":"Partner Webhooks","version":"1.0"},"tags":[{"name":"Notifications","description":"Notifications"}],"servers":[{"url":"http://client-api-address"}],"paths":{"/document-notification":{"post":{"summary":"Document Notification","operationId":"document-notification","tags":["Notifications"],"responses":{"200":{"description":"OK"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentNotification"}}}},"description":"Notification about document update related to event `DOCUMENT_NOTIFICATION`"}}},"components":{"schemas":{"DocumentNotification":{"title":"DocumentNotification","type":"object","properties":{"documentId":{"type":"string","format":"uuid"},"modifiedOn":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/DocumentStatusEnum"},"notificationType":{"$ref":"#/components/schemas/NotificationTypeEnum"},"validationError":{"$ref":"#/components/schemas/DocumentValidationError"}},"required":["documentId","modifiedOn","status","notificationType"]},"DocumentStatusEnum":{"title":"DocumentStatusEnum","type":"string","enum":["RECEIVED","INVALID","CREATED","PENDING","APPROVED","REJECTED","ARCHIVED"]},"NotificationTypeEnum":{"title":"NotificationTypeEnum","type":"string","enum":["CREATED","UPDATED","DELETED","VALIDATION_ERROR"]},"DocumentValidationError":{"title":"DocumentValidationError","type":"object","properties":{"errorType":{"$ref":"#/components/schemas/DocumentValidationErrorEnum"},"description":{"type":"string"}},"required":["errorType","description"]},"DocumentValidationErrorEnum":{"title":"DocumentValidationErrorEnum","type":"string","enum":["UNKNOWN_ERROR","DATA_NOT_FOUND_ERROR","INVALID_DATA_ERROR"]}}}} ``` ## Customer Product Notification > Notifications about customer product update related to event \`CUSTOMER\_PRODUCT\_NOTIFICATION\` ```json {"openapi":"3.0.1","info":{"title":"Partner Webhooks","version":"1.0"},"tags":[{"name":"Notifications","description":"Notifications"}],"servers":[{"url":"http://client-api-address"}],"paths":{"/customer-product-notification":{"post":{"summary":"Customer Product Notification","operationId":"customer-product-notification","tags":["Notifications"],"responses":{"200":{"description":"OK"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerProductNotification"}}}},"description":"Notifications about customer product update related to event `CUSTOMER_PRODUCT_NOTIFICATION`"}}},"components":{"schemas":{"CustomerProductNotification":{"title":"CustomerProductNotification","type":"object","properties":{"customerId":{"type":"string","format":"uuid"},"customerProductId":{"type":"string","format":"uuid"},"modifiedOn":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/CustomerProductStatusEnum"},"notificationType":{"$ref":"#/components/schemas/NotificationTypeEnum"},"validationError":{"$ref":"#/components/schemas/CustomerProductValidationError"}},"required":["customerId","customerProductId","notificationType"]},"CustomerProductStatusEnum":{"title":"CustomerProductStatusEnum","type":"string","enum":["PENDING","ACTIVE","BLOCKED","RESTRICTED","INACTIVE","CLOSED","INVALID","REJECTED"]},"NotificationTypeEnum":{"title":"NotificationTypeEnum","type":"string","enum":["CREATED","UPDATED","DELETED","VALIDATION_ERROR"]},"CustomerProductValidationError":{"title":"CustomerProductValidationError","type":"object","properties":{"errorType":{"$ref":"#/components/schemas/CustomerProductValidationErrorEnum"},"description":{"type":"string"}},"required":["errorType","description"]},"CustomerProductValidationErrorEnum":{"title":"CustomerProductValidationErrorEnum","type":"string","enum":["PRODUCT_NOT_ACTIVE","CUSTOMER_NOT_FOUND","ACTIVE_CUSTOMER_REQUIRED","CUSTOMER_PRODUCT_PER_CUSTOMER_LIMIT_REACHED","CUSTOMER_PRODUCT_QUANTITY_AND_BALANCE_MUST_BE_ZERO","CUSTOMER_PRODUCT_NOT_FOUND","NOT_SETTLED_TRANSACTIONS_EXIST","REQUESTOR_ID_NOT_VALID"]}}}} ``` ## Legal Entity Search Notification > Notification about legal entity search changes related to event \`LEGAL\_ENTITY\_SEARCH\_NOTIFICATION\` ```json {"openapi":"3.0.1","info":{"title":"Partner Webhooks","version":"1.0"},"tags":[{"name":"Notifications","description":"Notifications"}],"servers":[{"url":"http://client-api-address"}],"paths":{"/legal-entity-search-notification":{"post":{"summary":"Legal Entity Search Notification","operationId":"legal-entity-search-notification","tags":["Notifications"],"responses":{"200":{"description":"OK"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalEntitySearchNotification"}}}},"description":"Notification about legal entity search changes related to event `LEGAL_ENTITY_SEARCH_NOTIFICATION`"}}},"components":{"schemas":{"LegalEntitySearchNotification":{"title":"LegalEntitySearchNotification","type":"object","properties":{"searchId":{"type":"string","format":"uuid"},"modifiedOn":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/LegalEntitySearchStatusEnum"}},"required":["searchId","modifiedOn","status"]},"LegalEntitySearchStatusEnum":{"title":"LegalEntitySearchStatusEnum","type":"string","enum":["WAITING_FOR_DATA","WAITING_FOR_DOCUMENTS","READY_DATA","READY_DOCUMENTS","PREPARING","COMPLETED","FAILED","ERROR"],"description":"status of the search"}}}} ``` ## Strategy Notification > Notification about strategy update related to event \`STRATEGY\_NOTIFICATION\` ```json {"openapi":"3.0.1","info":{"title":"Partner Webhooks","version":"1.0"},"tags":[{"name":"Notifications","description":"Notifications"}],"servers":[{"url":"http://client-api-address"}],"paths":{"/strategy-notification":{"post":{"summary":"Strategy Notification","operationId":"strategy-notification","tags":["Notifications"],"responses":{"200":{"description":"OK","content":{}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StrategyNotification"}}}},"description":"Notification about strategy update related to event `STRATEGY_NOTIFICATION`"}}},"components":{"schemas":{"StrategyNotification":{"title":"StrategyNotification","type":"object","properties":{"strategyId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid"},"modifiedOn":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/StrategyStatusEnum"},"notificationType":{"$ref":"#/components/schemas/NotificationTypeEnum"},"validationError":{"$ref":"#/components/schemas/StrategyValidationError"}},"required":["strategyId","notificationType"]},"StrategyStatusEnum":{"title":"StrategyStatusEnum","type":"string","enum":["EXECUTING","PENDING","EXPIRED","RECEIVED","INVALID","DELETED","REJECTED"]},"NotificationTypeEnum":{"title":"NotificationTypeEnum","type":"string","enum":["CREATED","UPDATED","DELETED","VALIDATION_ERROR"]},"StrategyValidationError":{"title":"StrategyValidationError","type":"object","properties":{"errorType":{"$ref":"#/components/schemas/StrategyValidationErrorEnum"},"description":{"type":"string"}},"required":["errorType","description"]},"StrategyValidationErrorEnum":{"title":"StrategyValidationErrorEnum","type":"string","enum":["ALREADY_EXISTS_ERROR","DATA_NOT_FOUND_ERROR","SUBSCRIBER_INVALID_DATA_ERROR","STRATEGY_INVALID_DATA_ERROR","UNKNOWN_ERROR"]}}}} ``` ## Transfer Notification > Notification about transfer update related to event \`TRANSFER\_NOTIFICATION\` ```json {"openapi":"3.0.1","info":{"title":"Partner Webhooks","version":"1.0"},"tags":[{"name":"Notifications","description":"Notifications"}],"servers":[{"url":"http://client-api-address"}],"paths":{"/transfer-notification":{"post":{"summary":"Transfer Notification","operationId":"transfer-notification","tags":["Notifications"],"responses":{"200":{"description":"OK","content":{}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferNotification"}}}},"description":"Notification about transfer update related to event `TRANSFER_NOTIFICATION`"}}},"components":{"schemas":{"TransferNotification":{"title":"TransferNotification","type":"object","properties":{"customerId":{"type":"string","format":"uuid"},"customerProductId":{"type":"string","format":"uuid"},"transferId":{"type":"string","format":"uuid"},"modifiedOn":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/TransferStatusEnum"},"notificationType":{"$ref":"#/components/schemas/NotificationTypeEnum"},"validationError":{"$ref":"#/components/schemas/TransferValidationError"}},"required":["customerId","customerProductId","transferId","notificationType"]},"TransferStatusEnum":{"title":"TransferStatusEnum","type":"string","enum":["RECEIVED","INVALID","PENDING","REJECTED","PROCESSED","RECONCILED"]},"NotificationTypeEnum":{"title":"NotificationTypeEnum","type":"string","enum":["CREATED","UPDATED","DELETED","VALIDATION_ERROR"]},"TransferValidationError":{"title":"TransferValidationError","type":"object","properties":{"errorType":{"$ref":"#/components/schemas/TransferValidationErrorEnum"},"description":{"type":"string"}},"required":["errorType","description"]},"TransferValidationErrorEnum":{"title":"TransferValidationErrorEnum","type":"string","enum":["INSUFFICIENT_BALANCE","INVALID_IBAN","IBAN_BIC_MISMATCH","ACTIVE_PRODUCT_REQUIRED","PRODUCT_NOT_FOUND","ACTIVE_CUSTOMER_REQUIRED","CUSTOMER_NOT_FOUND","DATA_NOT_FOUND_ERROR","INAPPROPRIATE_DATA_STATUS_ERROR","REF_ACCOUNT_OR_ACCOUNT_PRODUCT_IBAN_REQUIRED","ACCOUNT_PRODUCT_REQUIRED","INSUFFICIENT_WITHDRAWABLE_BALANCE","RECEIVER_IBAN_SAME_AS_PRODUCT_IBAN","REQUESTOR_ID_NOT_VALID"]}}}} ``` ## Digital Asset Order Notification > Notification about digital asset order update related to event \`DIGITAL\_ASSET\_ORDER\_NOTIFICATION\` ```json {"openapi":"3.0.1","info":{"title":"Partner Webhooks","version":"1.0"},"tags":[{"name":"Notifications","description":"Notifications"}],"servers":[{"url":"http://client-api-address"}],"paths":{"/digital-asset-order-notification":{"post":{"summary":"Digital Asset Order Notification","operationId":"digital-asset-order-notification","tags":["Notifications"],"responses":{"200":{"description":"OK","content":{}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DigitalAssetOrderNotification"}}}},"description":"Notification about digital asset order update related to event `DIGITAL_ASSET_ORDER_NOTIFICATION`"}}},"components":{"schemas":{"DigitalAssetOrderNotification":{"title":"DigitalAssetOrderNotification","type":"object","properties":{"orderId":{"type":"string","format":"uuid"},"customerProductId":{"type":"string","format":"uuid"},"externalId":{"type":"string"},"status":{"$ref":"#/components/schemas/DigitalAssetOrderStatusEnum"},"notificationType":{"$ref":"#/components/schemas/NotificationTypeEnum"},"validationError":{"$ref":"#/components/schemas/DigitalAssetOrderError"},"executionData":{"$ref":"#/components/schemas/DigitalAssetsOrderExecutionData"}},"required":["orderId","customerProductId","status","notificationType","externalId"]},"DigitalAssetOrderStatusEnum":{"title":"DigitalAssetOrderStatusEnum","type":"string","enum":["RECEIVED","INVALID","PENDING","CANCELED","REJECTED","FILLED","CORRECTED","SETTLED"]},"NotificationTypeEnum":{"title":"NotificationTypeEnum","type":"string","enum":["CREATED","UPDATED","DELETED","VALIDATION_ERROR"]},"DigitalAssetOrderError":{"title":"DigitalAssetOrderError","type":"object","properties":{"errorType":{"$ref":"#/components/schemas/DigitalAssetOrderErrorEnum"},"description":{"type":"string"}},"required":["errorType","description"]},"DigitalAssetOrderErrorEnum":{"title":"DigitalAssetOrderErrorEnum","type":"string","enum":["ASSET_NOT_ACTIVE","ASSET_NOT_FOUND","BALANCE_UPDATE_FAILED","CASH_CUSTOMER_PRODUCT_NOT_ACTIVE","CASH_CUSTOMER_PRODUCT_NOT_FOUND","CASH_CUSTOMER_PRODUCT_REQUIRED","DIFFERENT_CUSTOMERS_FOR_CUSTOMER_PRODUCTS","INSUFFICIENT_BALANCE","INSUFFICIENT_POSITION","ORDER_CANNOT_BE_SUBMITTED","ORDER_CASH_AMOUNT_OUT_OF_BOUNDS","ORDER_SAVING_FAILED","VALIDATION_FAILED","WALLET_CUSTOMER_PRODUCT_NOT_ACTIVE","WALLET_CUSTOMER_PRODUCT_NOT_FOUND","WALLET_CUSTOMER_PRODUCT_REQUIRED"]},"DigitalAssetsOrderExecutionData":{"title":"DigitalAssetsOrderExecutionData","type":"object","properties":{"quantity":{"type":"number"},"executionPrice":{"type":"number"},"executionAmount":{"type":"number"},"feeDescription":{"type":"string"},"feeAmount":{"type":"number"}},"required":["quantity","executionPrice","executionAmount"]}}}} ``` ## Traditional Asset Order Notification > Notification about traditional asset order update related to event \`TRADITIONAL\_ASSET\_ORDER\_NOTIFICATION\` ```json {"openapi":"3.0.1","info":{"title":"Partner Webhooks","version":"1.0"},"tags":[{"name":"Notifications","description":"Notifications"}],"servers":[{"url":"http://client-api-address"}],"paths":{"/traditional-asset-order-notification":{"post":{"summary":"Traditional Asset Order Notification","operationId":"traditional-asset-order-notification","tags":["Notifications"],"responses":{"200":{"description":"OK","content":{}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TraditionalAssetOrderNotification"}}}},"description":"Notification about traditional asset order update related to event `TRADITIONAL_ASSET_ORDER_NOTIFICATION`"}}},"components":{"schemas":{"TraditionalAssetOrderNotification":{"title":"TraditionalAssetOrderNotification","type":"object","properties":{"orderId":{"type":"string","format":"uuid"},"customerProductId":{"type":"string","format":"uuid"},"externalId":{"type":"string"},"exAnteId":{"type":"string","format":"uuid","description":"The ex ante id is returned for RECEIVED orders"},"executionId":{"type":"string","format":"uuid","description":"The trade execution id is returned for FILLED and PARTIALLY_FILLED orders"},"status":{"$ref":"#/components/schemas/TraditionalAssetOrderStatusEnum"},"notificationType":{"$ref":"#/components/schemas/NotificationTypeEnum"},"validationError":{"$ref":"#/components/schemas/TraditionalAssetOrderError"},"executionData":{"$ref":"#/components/schemas/TraditionalAssetOrderExecutionData"}},"required":["orderId","customerProductId","status","notificationType","externalId"]},"TraditionalAssetOrderStatusEnum":{"title":"TraditionalAssetOrderStatusEnum","type":"string","enum":["RECEIVED","INVALID","PLACED","UPDATED","REJECTED","FILLED","PARTIALLY_FILLED","CANCELLED","RECONCILIATION_CORRECTION","EXPIRED","PENDING","CANCELLATION_REJECTED","CANCELLATION_ACCEPTED","PARTIALLY_FILLED_CANCELLED","PARTIALLY_FILLED_EXPIRED"]},"NotificationTypeEnum":{"title":"NotificationTypeEnum","type":"string","enum":["CREATED","UPDATED","DELETED","VALIDATION_ERROR"]},"TraditionalAssetOrderError":{"title":"TraditionalAssetOrderError","type":"object","properties":{"errorType":{"$ref":"#/components/schemas/TraditionalAssetOrderNotificationErrorCodeEnum"},"description":{"type":"string"}},"required":["errorType","description"]},"TraditionalAssetOrderNotificationErrorCodeEnum":{"title":"TraditionalAssetOrderNotificationErrorCodeEnum","type":"string","enum":["INSUFFICIENT_BALANCE","INSUFFICIENT_POSITION","ASSET_NOT_FOUND","ASSET_NOT_ACTIVE","ORDER_CANNOT_BE_SUBMITTED","DEPOSITORY_CUSTOMER_PRODUCT_NOT_FOUND","DEPOSITORY_CUSTOMER_PRODUCT_REQUIRED","DEPOSITORY_CUSTOMER_PRODUCT_NOT_ACTIVE","CASH_CUSTOMER_PRODUCT_NOT_FOUND","CASH_CUSTOMER_PRODUCT_REQUIRED","CASH_CUSTOMER_PRODUCT_NOT_ACTIVE","DIFFERENT_CUSTOMERS_FOR_CUSTOMER_PRODUCTS","LEGAL_ENTITY_IDENTIFIER_NOT_SET","LEGAL_ENTITY_IDENTIFIER_NOT_VALID","NATIONAL_IDENTIFIER_NOT_SET","REQUESTOR_ID_NOT_VALID","ORDER_NOT_CANCELABLE","ORDER_PENDING_CANCELATION","ORDER_CANCELATION_REJECTED","ORDER_REJECTED","ORDER_DOES_NOT_COVER_FEE"]},"TraditionalAssetOrderExecutionData":{"title":"TraditionalAssetOrderExecutionData","type":"object","properties":{"quantity":{"type":"number"},"executionPrice":{"type":"number"},"executionAmount":{"type":"number"},"germanCit":{"type":"number","format":"decimal","description":"Total sum of german capital income tax amount of the total execution"},"solidaritySurcharge":{"type":"number","format":"decimal","description":"Total sum of german solidarity surcharge tax amount of the total execution"},"churchTax":{"type":"number","format":"decimal","description":"Total sum of german church tax amount of the total execution"},"feeAmount":{"type":"number","multipleOf":0.01},"feeDescription":{"type":"string"}},"required":["quantity","executionPrice","executionAmount","germanCit","solidaritySurcharge","churchTax"]}}}} ``` ## User Notification > Notification related to event \`USER\_NOTIFICATION\` ```json {"openapi":"3.0.1","info":{"title":"Partner Webhooks","version":"1.0"},"tags":[{"name":"Notifications","description":"Notifications"}],"servers":[{"url":"http://client-api-address"}],"paths":{"/user-notification":{"post":{"summary":"User Notification","operationId":"user-notification","tags":["Notifications"],"responses":{"200":{"description":"OK","content":{}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserNotification"}}}},"description":"Notification related to event `USER_NOTIFICATION`"}}},"components":{"schemas":{"UserNotification":{"title":"UserNotification","type":"object","properties":{"userId":{"type":"string"},"modifiedOn":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/UserStatusEnum"},"notificationType":{"$ref":"#/components/schemas/NotificationTypeEnum"},"validationError":{"$ref":"#/components/schemas/EntityValidationError"}},"required":["userId","notificationType"]},"UserStatusEnum":{"title":"UserStatusEnum","type":"string","enum":["RECEIVED","INVALID","CREATED","ACTIVE","REJECTED","INACTIVE","SUSPENDED"]},"NotificationTypeEnum":{"title":"NotificationTypeEnum","type":"string","enum":["CREATED","UPDATED","DELETED","VALIDATION_ERROR"]},"EntityValidationError":{"title":"EntityValidationError","type":"object","properties":{"errorType":{"$ref":"#/components/schemas/EntityValidationErrorEnum"},"description":{"type":"string"}},"required":["errorType","description"]},"EntityValidationErrorEnum":{"title":"EntityValidationErrorEnum","type":"string","enum":["ALREADY_EXISTS_ERROR","DATA_MISSING_ERROR","DATA_NOT_FOUND_ERROR","EVENT_NOT_FOUND_ERROR","INAPPROPRIATE_DATA_STATUS_ERROR","INVALID_DATA_ERROR","CREATE_REJECTED_BY_ADMIN_ERROR","UPDATE_REJECTED_BY_ADMIN_ERROR","EMAIL_ALREADY_EXISTS_ERROR","INVALID_STATUS_UPDATE_ERROR","NATURAL_PERSON_NOT_FOUND_ERROR","NATURAL_PERSON_NOT_IN_CREATED_STATUS_ERROR","UNKNOWN_ERROR"]}}}} ``` ## Real estate token prices Notification > Notification related to event \`RE\_TOKEN\_PRICES\` ```json {"openapi":"3.0.1","info":{"title":"Partner Webhooks","version":"1.0"},"tags":[{"name":"Notifications","description":"Notifications"}],"servers":[{"url":"http://client-api-address"}],"paths":{"/re-token-prices":{"post":{"summary":"Real estate token prices Notification","operationId":"re-token-prices-notification","tags":["Notifications"],"responses":{"200":{"description":"OK","content":{}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealEstateTokenPricesNotification"}}}},"description":"Notification related to event `RE_TOKEN_PRICES`"}}},"components":{"schemas":{"RealEstateTokenPricesNotification":{"type":"object","properties":{"regularToken":{"type":"number","format":"currency","minimum":0,"exclusiveMinimum":true},"premiumToken":{"type":"number","format":"currency","minimum":0,"exclusiveMinimum":true}},"required":["regularToken","premiumToken"]}}}} ``` ## Offboarding Notification > Notification about offboarding update related to event \`OFFBOARDING\_NOTIFICATION\` ```json {"openapi":"3.0.1","info":{"title":"Partner Webhooks","version":"1.0"},"tags":[{"name":"Notifications","description":"Notifications"}],"servers":[{"url":"http://client-api-address"}],"paths":{"/offboarding-notification":{"post":{"summary":"Offboarding Notification","operationId":"offboarding-notification","tags":["Notifications"],"responses":{"200":{"description":"OK","content":{}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OffboardingNotification"}}}},"description":"Notification about offboarding update related to event `OFFBOARDING_NOTIFICATION`"}}},"components":{"schemas":{"OffboardingNotification":{"title":"OffboardingNotification","type":"object","properties":{"offboardingId":{"type":"string","format":"uuid"},"modifiedOn":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/OffboardingStatusEnum"},"notificationType":{"$ref":"#/components/schemas/OffboardingNotificationTypeEnum"},"validationError":{"$ref":"#/components/schemas/OffboardingValidationError"}},"required":["offboardingId","modifiedOn","status","notificationType"]},"OffboardingStatusEnum":{"title":"OffboardingStatusEnum","type":"string","enum":["CREATED","PENDING","APPROVED","REJECTED","CANCELED","INVALID"]},"OffboardingNotificationTypeEnum":{"title":"OffboardingNotificationTypeEnum","type":"string","enum":["STARTED","PENDING","APPROVED","CANCELED","VALIDATION_ERROR"]},"OffboardingValidationError":{"title":"OffboardingValidationError","type":"object","properties":{"errorType":{"$ref":"#/components/schemas/OffboardingValidationErrorEnum"},"description":{"type":"string"}},"required":["errorType","description"]},"OffboardingValidationErrorEnum":{"title":"OffboardingValidationErrorEnum","type":"string","enum":["ALREADY_EXISTS_ERROR","DATA_NOT_FOUND_ERROR","INVALID_DATA_ERROR","UNKNOWN_ERROR"]}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.tradevest.ai/partner-apis/partner-webhooks.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.