Skip to main content
PATCH
/
apps
/
{client_id}
/
providers
/
{provider_id}
/
activation
/
company-info
curl -X PATCH \
  -H "Authorization: Bearer sk_workspace_test_..." \
  -H "Content-Type: application/json" \
  -d '{
    "legalCompanyName": "Acme Corp",
    "registrationNumber": "12345678",
    "registeredAddress": "123 Main St, Helsinki",
    "displayName": "Acme"
  }' \
  "https://sandbox.api.hopae.com/connect/v1/apps/abc123/providers/smartid/activation/company-info"

{
  "providerId": "smartid",
  "requiredFields": {
    "legalCompanyName": "Acme Corp",
    "registrationNumber": "12345678",
    "registeredAddress": "123 Main St, Helsinki",
    "displayName": "Acme"
  }
}
Submits or updates company information fields required by a specific provider. Only fields listed in the provider’s requiredFields (from Get Activation Steps) are accepted.

​
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

The request body is a flat JSON 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

​
legalCompanyName
string
Full legal name of the company.
​
displayName
string
Display name shown to end users.
Base64-encoded company logo image.
​
registrationNumber
string
Company registration number.
​
registeredAddress
string
Registered company address.
​
vatNumber
string
VAT number.
​
serviceDescription
string
Description of the service using the provider.
​
websiteUrl
string
Company website URL.
​
contactEmail
string
Contact email address.
​
contactPhone
string
Contact phone number.

​
Provider-specific fields

​
spidUserDataLevel
string
User data level. Allowed values: basic, advanced.
​
idinLegalRepName
string
Legal representative name.
​
idinLegalRepEmail
string
Legal representative email.
​
idinLegalRepPhone
string
Legal representative phone.
​
bankidNoBankName
string
Bank name.
​
bankidNoUseSsn
boolean
Whether to request the end-user SSN during verification.
​
bankidNoSsnReason
string
Reason for requesting SSN.
​
bankidNoGdprArticle
string
GDPR 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.
​
bankidNoSignatoryName
string
Signatory name.
​
bankidNoSignatoryEmail
string
Signatory email.
​
bankidNoSignatoryPhone
string
Signatory phone.
​
privacyPolicyUrl
string
Privacy policy URL.
​
termsOfServiceUrl
string
Terms of service URL.

​
Response

​
providerId
string
The provider the company info was updated for.
​
requiredFields
object
Key-value map of the provider’s required fields with their current values.
Once all required fields are submitted, the activation flow advances to the next step automatically. Call Get Activation Steps to check progress. 
curl -X PATCH \
  -H "Authorization: Bearer sk_workspace_test_..." \
  -H "Content-Type: application/json" \
  -d '{
    "legalCompanyName": "Acme Corp",
    "registrationNumber": "12345678",
    "registeredAddress": "123 Main St, Helsinki",
    "displayName": "Acme"
  }' \
  "https://sandbox.api.hopae.com/connect/v1/apps/abc123/providers/smartid/activation/company-info"

{
  "providerId": "smartid",
  "requiredFields": {
    "legalCompanyName": "Acme Corp",
    "registrationNumber": "12345678",
    "registeredAddress": "123 Main St, Helsinki",
    "displayName": "Acme"
  }
}