VerifiMeVerifiMe Developer Portal
Reference

Current Limitations

Known limitations and available data workarounds

  1. User Invite API:

    • Does not accept entityType parameter
    • Cannot restrict verification to a specific entity type
    • You or your customer needs to validate that the entity type verified matches the entity type in your flow
  2. Tracking Status API:

    • Only returns status: Active, Inactive, Completed
    • Does not return entity type information
  3. Webhook Payload:

    • Does not include explicit entityType field
    • Returns customerName field which contains the entity name
  4. Widget Callback:

    • onSuccess() returns undefined
    • No entity data provided

What Data IS Available

Customer Name Field: The webhook's customerName field contains the entity name that was verified:

  • For Individuals: Person's full name (e.g., "John Smith")
  • For SMSFs: Superannuation fund name (e.g., "Smith Family Superannuation Fund")
  • For Trusts: Trust name (e.g., "Smith Family Trust")
  • For Companies: Company name (e.g., "Smith Investments Pty Ltd")
  • For Partnerships: Partnership name (e.g., "Smith & Jones Partners")
  • For Sole Traders: Business name (e.g., "Smith Plumbing")

You can use this field as a proxy for entity validation by matching against expected entity names collected in your application form.

Future Enhancement: An explicit entityType field may be added in a future release.

On this page