Function names in webhook notifications
The following table provides a comprehensive list of the function names we use in webhook notifications:
| Webhook function | Reference/Definition |
|---|---|
| AssociatedEntityStatusChange | used when there's a change to an associated entity |
| BlacklistEntity | Set Entity Blacklist State |
| BusinessDocumentCatalogue | (International) List available documents in catalogue |
| BusinessOwnershipQuery | (AUS Only) Create Business Entity and Query UBO |
| BusinessOwnershipSubscription | (AUS Only) Subscribe or unsubscribe to continuous monitoring of business details and ownership. |
| CheckOrganisation | (AUS Only) Run KYC/AML Checks on Organisation and/or Associated Individuals. |
| CheckTransactionRisk | When asynchronous KYT transaction check has been sent, this notification is sent when the check has been successfully processed |
| CreateAssociateEntity | (AUS Only) Make a new entity a direct associated entity of a parent organisation. |
| CreateCheckEntity | Create and Verify Entity |
| CreateCheckEntityPushToMobile | Create Entity and Push Self-Verification Link |
| CreateDocument | Create New Document. |
| CreateEntity | Create New Entity. |
| CreateEntityGetIDVToken | Create Entity and Get IDV Token |
| CreateProcessIndustryUtilityDocument | Create Document and Run Utility Price Comparison. |
| DeleteDocument | Delete Document. |
| DeleteEntity | Delete Entity |
| DeleteEntityAssociation | (AUS Only) Remove a previously created association between an entity (otherId) and a parent organisation (entityId). |
| EntityMonitoring | Set Entity Ongoing AML Monitoring Status. |
| EntityProfileChange | When there's a change to an entity profile recipe |
| EntityRiskChange | When an entity risk score changes |
| EntityStatusChange | When an entity overall status changes |
| FlagDuplicateEntity | Resolve Duplicate States |
| InternationalBusinessProfile | (International) Retrieve a business profile from any country. |
| InternationalBusinessSearch | (International) Search for a business from any country. |
| notifyResult | Push Notification Payload |
| OrderBusinessDocument | (International) Order document from catalogue |
| QueryDocument | Retrieve Document Details |
| QueryDocumentChecks | Retrieve Document Verification Check Details. |
| QueryDocumentFull | Retrieve Document and Scan Data |
| QueryEntity | Retrieve Entity Details |
| QueryEntityChecks | https://apidocs.frankiefinancial.com/reference/queryentitychecks |
| QueryEntityFull | Retrieve Entity Details and Document Scan Data |
| QueryOwnershipChecks | (AUS Only) Retrieve previous UBO query results |
| QueryParentAssociations | (AUS Only) Retrieve all the parent associations for an Individual or a Business |
| RetrieveResult | (Re)retrieve Response Result. |
| RunBusinessReports | (AUS Only) Run Report(s) against a new or existing organisation entity. |
| RunBusinessReportsMulti | https://apidocs.frankiefinancial.com/reference/runbusinessreportsmulti |
| SearchDocument | Search For a Document [Beta] |
| StatusCheck | Service Status |
| UpdateAssociateEntity | (AUS Only) Make an existing entity (otherId) a directly associated entity of a parent organisation (entityId), or update an existing association. |
| UpdateCheckEntity | Update Entity and Verify Details |
| UpdateCheckEntityPushToMobile | Update Entity and Push Self-Verification Link |
| UpdateDocument | Update Existing Document |
| UpdateEntity | Update Existing Entity |
| UpdateEntityGetIDVToken | Update Entity and Get IDV Token |
| UpdateEntityInitIDVProcess | https://apidocs.frankiefinancial.com/reference/updateentityinitidvprocess |
| UpdateEntityState | When you manually override the result of an entity in Portal, the entity status will change, and this notification will be sent to your webhook. |
| UpdateEvaluateEntity | Update Entity and evaluate current results and risk without running any new checks |
| UpdateProcessIndustryUtilityDocument | Update Document and Run Utility Price Comparison |
| UpdateProcessIndustryUtilityDocumentConsent | Provide Explicit Consent to Switch Utility Plans |
| UpdateProcessIndustryUtilityDocumentSwitch | Initiate Switching of Utility Plan |
| UpdateTransactionCase | The notification is sent when a change in status/resolution for an Alert occurs - https://apidocs.frankiefinancial.com/reference/patchbulkresolvecases |
| UpdateVerifyDocument | Update and Verify Document |
| VerifyDocument | Create and Verify Document |
| WatchlistEntity | Set Entity Watchlist State |
Updated about 2 months ago