How To Decide on an Entity ID ?

How To create or decide on an Entity ID value in the onboarding request ?

  • An Entity ID is a unique identifier that represents a specific entity such as an FIU (Financial Information User), AA (Account Aggregator), or FIP (Financial Information Provider). It should follow a clear, readable naming convention that helps identify the entity.

  • Best practice for naming Entity IDs: Use a suffix-based naming convention like:

    • For FIUs: XYZ_FIU

    • For AAs: ABC_AA

    • For FIPs: AXBYCZ_FIP

  • For Lower environments you can even add the environment name as well

    • For FIU : XYZ_UAT_FIU or XYX_SANDBOX_FIU

    • For AA : ABC_UAT_AA or ABC_SANDBOX_AA

    • For FIP : AXBYCZ_UAT_FIP or AXBYCZ_SANDBOX_FIP

  • Ensure that the Entity ID is a unique and easily recognisable name of the organisation that is getting onboarded. It can include letters, numbers, or symbols, but a simple and meaningful string is recommended.

  • Do note, the above examples and recommendations use an underscore ( _ ) as the delimiter. You can also use hyphens ( - ) if preferred.

Was this helpful?