SahamatiNet
  • Background
  • SahamatiNet POC
    • Introduction
    • Applications
    • Observability
    • Integration Steps
      • Sandbox Onboarding
      • IAM APIs
      • CR APIs
      • Integration with Router
        • Sample Code Snippets
          • Python
          • Java
          • JavaScript
          • GoLang
          • C#
        • Router APIs Specifications
          • FIU API Specification
          • AA API Specification
          • FIP API Specification
      • ReBIT Workflows using Router
        • Account Discovery & Linking
        • Consent Workflow
        • FI Request Workflow
    • Integration with Simulators
      • AA Simulator
      • FIP Simulator
      • FIU Simulator
    • Validation of Integration
  • Glossary
  • Guidelines
  • Frequently Asked Questions
  • How To Guides
    • How To Onboard to Sandbox ?
    • How To Decide on an Entity ID ?
    • How To Generate a Certificate ?
    • How To Generate Tokens ?
Powered by GitBook
LogoLogo

Copyright © 2025 - Sahamati Foundation

On this page

Was this helpful?

Export as PDF
  1. How To Guides

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.

PreviousHow To Onboard to Sandbox ?NextHow To Generate a Certificate ?

Was this helpful?