Skip to main content
Each provider must go through an activation flow before it can process verifications. The required steps depend on your environment and the specific provider. Call Get Activation Steps at any point to retrieve the exact step sequence and current progress. The response contains a steps array — each object has a type field (e.g., enable, company-info, upload) that tells you which step it is, and currentStepIndex tells you where you are in the sequence.

​
Sandbox Quick Start

In sandbox, activation is the same for all providers — just enable the provider and it is immediately activated. No company information, documents, or review is needed. 
# 1. Enable the provider
curl -X PATCH \
  -H "Authorization: Bearer sk_workspace_test_..." \
  -H "Content-Type: application/json" \
  -d '{"enabled": true}' \
  "https://sandbox.api.hopae.com/connect/v1/apps/abc123/providers/smartid/activation"

# Response: { "providerId": "smartid", "enabled": true, "currentStep": "activated" }
# Done — the provider is now active in sandbox.

​
Production Activation

In production, additional steps are required depending on the provider. The exact steps are returned by the Get Activation Steps endpoint. Below are the common step sequences:
StepsExample providers
enable →**company-info** → api-key → activatedSmart-ID, MitID, BankID SE
enable →**company-info** → upload → review → api-key → activatedFTN, SPID, iDIN
enable →**upload** → review → api-key → activatediPIN, PASS
enable →**book-meeting** → api-key → activatedID Austria, Singpass, UAE PASS
Step sequences may be updated as providers evolve. Always use Get Activation Steps as the source of truth rather than hardcoding the sequences above.

​
Step-by-step walkthrough

​
1. Check the required steps

Start by calling Get Activation Steps to see what the provider requires and where you currently are: 
curl -H "Authorization: Bearer sk_workspace_..." \
  "https://api.hopae.com/connect/v1/apps/abc123/providers/ftn/activation/steps"
The response state will be not_started, in_progress, or completed. Use currentStepIndex and the steps[].type values to determine which step to complete next.

​
2. Enable the provider

Every provider starts with the enable step. Call Enable Provider with {"enabled": true}. The response includes currentStep, which tells you what to do next.
Disabling a provider does not reset progress. When you enable it again, the flow resumes from where you left off.

​
3. Submit company information

If the next step is company-info, call Get Activation Steps to read the requiredFields array — it lists exactly which fields the provider needs, their data types, and any allowed values. Submit them via Update Company Info.

​
4. Upload documents

If the next step is upload, the step object in Get Activation Steps contains a documents array listing the required documents. Some include a templateUrl you can download. Upload the files via Upload Documents.

​
5. Book a meeting

If the next step is book-meeting, the step object in Get Activation Steps contains a bookingUrl. Open this URL to schedule a meeting with the Hopae team.

​
6. Wait for review

If the provider requires document uploads, the Hopae team will review them. No action is required — use Get Activation Steps to check when the review is complete.
If a document is rejected, the step moves back to upload. Check the uploaded array for documents with "state": "rejected" and a note explaining what needs to be corrected, then re-upload to the Upload Documents endpoint.

​
7. API key issuance

Once review is complete, production API keys are being issued. No action is required — use Get Activation Steps to check state is completed. The provider is then fully activated and ready to process live verifications.

​
Step Summary

Each step below corresponds to a type value in the steps array returned by Get Activation Steps.
StepRequires actionWhat needs to happen
enableYesEnable the provider. Enable Provider
company-infoYesSubmit all required company information fields. Update Company Info
uploadYesUpload all required documents. Upload Documents
review—Hopae reviews and confirms the uploaded documents.
book-meetingYesUse the bookingUrl returned in the step to schedule a meeting with Hopae.
api-key—Production API keys are being issued.
activated—Provider is fully activated and ready to go live.