Providers
Provider Activation
Redirect URIs
Workflows
curl -H "Authorization: Bearer sk_workspace_test_..." \
"https://sandbox.api.hopae.com/connect/v1/apps/abc123/providers/mitid/activation/steps"
{
"state": "in_progress",
"currentStepIndex": 1,
"steps": [
{
"type": "enable",
"title": "Enable Provider",
"description": "Enable this provider to proceed to the next steps."
},
{
"type": "activation-form",
"title": "Submit Activation Request Form",
"description": "Submit the required information for provider activation.",
"requiredFields": [
{ "label": "Legal Company Name", "name": "legalCompanyName", "value": "", "type": "string" },
{ "label": "Registration Number", "name": "registrationNumber", "value": "", "type": "string" },
{ "label": "Service Description", "name": "serviceDescription", "value": "", "type": "string" },
{ "label": "Display Name", "name": "displayName", "value": "", "type": "string" },
{ "label": "Contact Email", "name": "contactEmail", "value": "", "type": "string" }
],
"form": null
},
{
"type": "api-key",
"title": "Issuing Production API Key",
"description": "Production API keys are being issued."
},
{
"type": "activated",
"title": "Provider Activated",
"description": "API key has successfully been issued and configured."
}
]
}
Provider Activation
Get Activation Steps
Retrieve the computed activation steps for a specific provider.
GET
/
apps
/
{client_id}
/
providers
/
{provider_id}
/
activation
/
steps
curl -H "Authorization: Bearer sk_workspace_test_..." \
"https://sandbox.api.hopae.com/connect/v1/apps/abc123/providers/mitid/activation/steps"
{
"state": "in_progress",
"currentStepIndex": 1,
"steps": [
{
"type": "enable",
"title": "Enable Provider",
"description": "Enable this provider to proceed to the next steps."
},
{
"type": "activation-form",
"title": "Submit Activation Request Form",
"description": "Submit the required information for provider activation.",
"requiredFields": [
{ "label": "Legal Company Name", "name": "legalCompanyName", "value": "", "type": "string" },
{ "label": "Registration Number", "name": "registrationNumber", "value": "", "type": "string" },
{ "label": "Service Description", "name": "serviceDescription", "value": "", "type": "string" },
{ "label": "Display Name", "name": "displayName", "value": "", "type": "string" },
{ "label": "Contact Email", "name": "contactEmail", "value": "", "type": "string" }
],
"form": null
},
{
"type": "api-key",
"title": "Issuing Production API Key",
"description": "Production API keys are being issued."
},
{
"type": "activated",
"title": "Provider Activated",
"description": "API key has successfully been issued and configured."
}
]
}
Returns the activation steps, current progress, and overall state for a provider. Steps vary by provider.
Request
Bearer <API_KEY> from Console > Developers > Workspace API Keys.Path parameters
Client identifier of the app.
Provider identifier (e.g.,
smartid, ftn, mitid).Response
Overall activation state:
not_started, in_progress, or completed.Zero-based index of the first incomplete step. Equals the last step index when all steps are completed.
Ordered list of activation steps. Each step contains:
Show Step object
Show Step object
Step identifier:
enable, activation-form, book-meeting, api-key, or activated.Human-readable step title.
Human-readable step description.
(activation-form step only) List of required fields for the activation form.
Show Field object
Show Field object
Display label.
Field key used in the
data object of the submit request body.Current value, or empty string if not yet provided.
Data type:
string, base64, or boolean.(activation-form step only) Previously submitted form details, or
null if no form has been submitted yet.(book-meeting step only) URL to schedule a meeting.
curl -H "Authorization: Bearer sk_workspace_test_..." \
"https://sandbox.api.hopae.com/connect/v1/apps/abc123/providers/mitid/activation/steps"
{
"state": "in_progress",
"currentStepIndex": 1,
"steps": [
{
"type": "enable",
"title": "Enable Provider",
"description": "Enable this provider to proceed to the next steps."
},
{
"type": "activation-form",
"title": "Submit Activation Request Form",
"description": "Submit the required information for provider activation.",
"requiredFields": [
{ "label": "Legal Company Name", "name": "legalCompanyName", "value": "", "type": "string" },
{ "label": "Registration Number", "name": "registrationNumber", "value": "", "type": "string" },
{ "label": "Service Description", "name": "serviceDescription", "value": "", "type": "string" },
{ "label": "Display Name", "name": "displayName", "value": "", "type": "string" },
{ "label": "Contact Email", "name": "contactEmail", "value": "", "type": "string" }
],
"form": null
},
{
"type": "api-key",
"title": "Issuing Production API Key",
"description": "Production API keys are being issued."
},
{
"type": "activated",
"title": "Provider Activated",
"description": "API key has successfully been issued and configured."
}
]
}
⌘I