What is activation?
Activation is the one-time setup that connects your app to an eID provider so it can run verifications. Every provider you want to use must be activated once for your app before it accepts real users.Why is it needed?
Most eID providers, especially those backed by governments or banks, need to know who is relying on their identity data before they release it. So each provider has its own onboarding step before you can go live. Hopae manages this process for you and turns it into a single step, instead of a separate onboarding with each provider.Activation types
Providers differ in how much is needed to turn them on. Each one falls into one of three types:| Type | What it means |
|---|---|
| Direct | Turns on immediately. There is nothing for you to fill in. |
| Registration | You provide a few business details, then the provider reviews and approves them before it turns on. |
| Contract | Needs a separate agreement. You reach out, and Hopae arranges onboarding with the provider. |
Status and lifecycle
Every provider moves through a small set of states. You can read the current state at any time and show it in your own UI.| Status | What it means |
|---|---|
not_activated | Not set up yet. This is where every provider starts. |
activation_requested | You have submitted your details, and they are waiting to be reviewed. |
activation_processing | Your submission is being reviewed and set up. |
rejected | Something needs fixing. You can update your details and submit again. |
activated | Ready to use for verifications. |
- Direct providers skip the review and become
activatedright away. - Registration providers go through review before they are approved or rejected.
rejectedis not the end. Fixing your details and submitting again restarts the review.- Contract providers stay
not_activateduntil the separate onboarding with the provider is complete.
Shared company details
The first time you activate a provider, the business details you enter (company name, address, contact, and so on) are saved to your app. The next provider you activate prefills those shared details, so you do not re-enter them every time. Details that are specific to one provider stay with that provider.Sandbox
In the sandbox, activation is mocked. Nothing is sent to a real provider and there is no real review. Every provider simply becomesactivated so you can build and test the full flow. Registration providers show a brief activation_processing state first, to mimic real timing.
Because the sandbox always ends in activated, use it to check your integration, not to test rejection or real review.
Webhook notifications
When a provider becomes activated, or a submission is rejected, Hopae can notify your system with a webhook so you do not have to poll for changes. Webhooks fire in production only. See Webhook Signing for how to verify them.See also
- Submit Activation for the request and response details.
- Get Providers to read activation status and required fields.