Skip to main content
POST
/
apps
/
{client_id}
/
providers
/
{provider_id}
/
activation
/
form
curl -X POST \
  -H "Authorization: Bearer sk_workspace_test_..." \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "legalCompanyName": "Acme Corp",
      "registrationNumber": "12345678",
      "serviceDescription": "Identity verification",
      "displayName": "Acme",
      "contactEmail": "admin@acme.com"
    }
  }' \
  "https://sandbox.api.hopae.com/connect/v1/apps/abc123/providers/mitid/activation/form"

{
  "formId": "af_abc123def456",
  "clientId": "abc123",
  "providerId": "mitid",
  "data": {
    "legalCompanyName": "Acme Corp",
    "registrationNumber": "12345678",
    "serviceDescription": "Identity verification",
    "displayName": "Acme",
    "contactEmail": "admin@acme.com"
  },
  "status": "submitted",
  "createdAt": "2026-04-06T12:00:00.000Z"
}
Submits the activation request form for a specific provider. The data object must contain all fields listed in the provider’s requiredFields (from Get Activation Steps). A form can only be submitted once per provider. If the form was previously rejected, it can be resubmitted.

​
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, spid-ig, no-bankid).

​
Request body

​
data
object
required
Key-value object containing the provider’s required fields. Fields vary by provider — use the requiredFields from Get Activation Steps to determine which fields to submit.

​
Common fields

FieldTypeDescription
legalCompanyNamestringFull legal name of the company.
displayNamestringDisplay name shown to end users.
logostringBase64-encoded company logo image.
registrationNumberstringCompany registration number.
registeredAddressstringRegistered company address.
vatNumberstringVAT number.
serviceDescriptionstringDescription of the service using the provider.
websiteUrlstringCompany website URL.
contactEmailstringContact email address. Required for all providers.
contactPhonestringContact phone number.
FieldTypeDescription
spidUserDataLevelstringUser data level. Allowed values: basic, advanced.
FieldTypeDescription
idinLegalRepNamestringLegal representative name.
idinLegalRepEmailstringLegal representative email.
idinLegalRepPhonestringLegal representative phone.
FieldTypeDescription
bankidNoBankNamestringBank name.
bankidNoUseSsnbooleanWhether to request the end-user SSN during verification.
bankidNoSsnReasonstringReason for requesting SSN.
bankidNoGdprArticlestringGDPR legal basis. Allowed values: GDPR Art. 6(1)(a) - Consent, GDPR Art. 6(1)(b) - Contractual Performance, GDPR Art. 6(1)(c) - Legal Compliance, GDPR Art. 6(1)(f) - Legitimate Interest.
bankidNoSignatoryNamestringSignatory name.
bankidNoSignatoryEmailstringSignatory email.
bankidNoSignatoryPhonestringSignatory phone.
FieldTypeDescription
privacyPolicyUrlstringPrivacy policy URL.
termsOfServiceUrlstringTerms of service URL.
​
saveToCompanyInfo
boolean
If true, matching fields are also persisted to the app’s company information. Defaults to false.

​
Response

​
formId
string
Unique identifier of the submitted form.
​
clientId
string
Client identifier of the app.
​
providerId
string
The provider the form was submitted for.
​
data
object
The submitted form data.
​
status
string
Form status: submitted, processing, completed, or rejected.
​
createdAt
string
ISO 8601 timestamp of when the form was submitted.
Once the form is submitted, the activation flow advances to the next step automatically. Call Get Activation Steps to check progress. 
curl -X POST \
  -H "Authorization: Bearer sk_workspace_test_..." \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "legalCompanyName": "Acme Corp",
      "registrationNumber": "12345678",
      "serviceDescription": "Identity verification",
      "displayName": "Acme",
      "contactEmail": "admin@acme.com"
    }
  }' \
  "https://sandbox.api.hopae.com/connect/v1/apps/abc123/providers/mitid/activation/form"

{
  "formId": "af_abc123def456",
  "clientId": "abc123",
  "providerId": "mitid",
  "data": {
    "legalCompanyName": "Acme Corp",
    "registrationNumber": "12345678",
    "serviceDescription": "Identity verification",
    "displayName": "Acme",
    "contactEmail": "admin@acme.com"
  },
  "status": "submitted",
  "createdAt": "2026-04-06T12:00:00.000Z"
}