Skip to main content
PATCH
/
apps
/
{client_id}
/
providers
/
{provider_id}
/
activation
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/spid-ig/activation"

{
  "providerId": "spid-ig",
  "enabled": true,
  "currentStep": "activation-form"
}

Documentation Index

Fetch the complete documentation index at: https://docs.hopae.com/llms.txt

Use this file to discover all available pages before exploring further.

Enables or disables a provider and returns the next required activation step.

​
Request

​
Authorization
string
required
Bearer <API_KEY> from Console > Developers > Workspace API Keys.
​
Content-Type
string
application/json

​
Path parameters

​
client_id
string
required
Client identifier of the app.
​
provider_id
string
required
Provider identifier (e.g., smartid, ftn, mitid).

​
Request body

​
enabled
boolean
required
true to enable the provider, false to disable it.

​
Response

​
providerId
string
The provider that was updated.
​
enabled
boolean
Whether the provider is now enabled.
​
currentStep
string
The next incomplete step: enable, activation-form, upload, api-key, or activated. Returns enable when the provider is turned off.Use this value to determine what to do next — for example, if currentStep is activation-form, proceed to Submit Activation Form, or if it is upload, proceed to Upload Activation Documents.
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/spid-ig/activation"

{
  "providerId": "spid-ig",
  "enabled": true,
  "currentStep": "activation-form"
}