Providers
Provider Activation
Redirect URIs
Workflows
curl -H "Authorization: Bearer sk_workspace_test_..." \
"https://sandbox.api.hopae.com/connect/v1/apps/abc123/providers/ftn/activation/steps"
{
"state": "in_progress",
"currentStepIndex": 2,
"steps": [
{
"type": "enable",
"title": "Enable Provider",
"description": "Enable this provider to proceed to the next steps."
},
{
"type": "company-info",
"title": "Complete Company Information",
"description": "Provide required company details for provider activation.",
"requiredFields": [
{ "label": "Legal Company Name", "name": "legalCompanyName", "value": "Acme Corp", "type": "string" },
{ "label": "Registration Number", "name": "registrationNumber", "value": "12345678", "type": "string" },
{ "label": "Service Description", "name": "serviceDescription", "value": "Identity verification", "type": "string" },
{ "label": "Display Name", "name": "displayName", "value": "Acme", "type": "string" },
{ "label": "Logo", "name": "logo", "value": "iVBORw0KGgoAAAANSUhEUgAA...", "type": "base64" }
]
},
{
"type": "upload",
"title": "Upload Documents",
"description": "Upload the required documents for provider activation.",
"documents": [
{
"label": "FTN Customer Agreement",
"templateUrl": "https://static.example.com/templates/customer_agreement.docx"
},
{
"label": "Appendix A - Confirmation regarding Personal Identity Codes",
"templateUrl": "https://static.example.com/templates/appendix.docx",
"optional": true
}
],
"uploaded": [
{
"contractId": "6789abcd",
"fileName": "customer_agreement.pdf",
"fileSize": 245760,
"contentType": "application/pdf",
"uploadedAt": "2026-03-20T10:30:00.000Z",
"state": "pending"
}
]
},
{
"type": "review",
"title": "Reviewing Documents",
"description": "Your documents are being reviewed."
},
{
"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/ftn/activation/steps"
{
"state": "in_progress",
"currentStepIndex": 2,
"steps": [
{
"type": "enable",
"title": "Enable Provider",
"description": "Enable this provider to proceed to the next steps."
},
{
"type": "company-info",
"title": "Complete Company Information",
"description": "Provide required company details for provider activation.",
"requiredFields": [
{ "label": "Legal Company Name", "name": "legalCompanyName", "value": "Acme Corp", "type": "string" },
{ "label": "Registration Number", "name": "registrationNumber", "value": "12345678", "type": "string" },
{ "label": "Service Description", "name": "serviceDescription", "value": "Identity verification", "type": "string" },
{ "label": "Display Name", "name": "displayName", "value": "Acme", "type": "string" },
{ "label": "Logo", "name": "logo", "value": "iVBORw0KGgoAAAANSUhEUgAA...", "type": "base64" }
]
},
{
"type": "upload",
"title": "Upload Documents",
"description": "Upload the required documents for provider activation.",
"documents": [
{
"label": "FTN Customer Agreement",
"templateUrl": "https://static.example.com/templates/customer_agreement.docx"
},
{
"label": "Appendix A - Confirmation regarding Personal Identity Codes",
"templateUrl": "https://static.example.com/templates/appendix.docx",
"optional": true
}
],
"uploaded": [
{
"contractId": "6789abcd",
"fileName": "customer_agreement.pdf",
"fileSize": 245760,
"contentType": "application/pdf",
"uploadedAt": "2026-03-20T10:30:00.000Z",
"state": "pending"
}
]
},
{
"type": "review",
"title": "Reviewing Documents",
"description": "Your documents are being reviewed."
},
{
"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, company-info, upload, review, book-meeting, api-key, or activated.Human-readable step title.
Human-readable step description.
(company-info step only) List of required company information fields.
Show Field object
Show Field object
Display label.
Field key used in the update request body.
Current value, or empty string if not yet provided.
Data type:
string, base64, or boolean.(upload step only) List of already-uploaded documents.
Show Uploaded document object
Show Uploaded document object
Unique identifier of the uploaded contract.
Original file name.
File size in bytes.
MIME type.
ISO 8601 timestamp.
pending, processed, or rejected.Review note from the Hopae team. Present when
state is rejected.(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/ftn/activation/steps"
{
"state": "in_progress",
"currentStepIndex": 2,
"steps": [
{
"type": "enable",
"title": "Enable Provider",
"description": "Enable this provider to proceed to the next steps."
},
{
"type": "company-info",
"title": "Complete Company Information",
"description": "Provide required company details for provider activation.",
"requiredFields": [
{ "label": "Legal Company Name", "name": "legalCompanyName", "value": "Acme Corp", "type": "string" },
{ "label": "Registration Number", "name": "registrationNumber", "value": "12345678", "type": "string" },
{ "label": "Service Description", "name": "serviceDescription", "value": "Identity verification", "type": "string" },
{ "label": "Display Name", "name": "displayName", "value": "Acme", "type": "string" },
{ "label": "Logo", "name": "logo", "value": "iVBORw0KGgoAAAANSUhEUgAA...", "type": "base64" }
]
},
{
"type": "upload",
"title": "Upload Documents",
"description": "Upload the required documents for provider activation.",
"documents": [
{
"label": "FTN Customer Agreement",
"templateUrl": "https://static.example.com/templates/customer_agreement.docx"
},
{
"label": "Appendix A - Confirmation regarding Personal Identity Codes",
"templateUrl": "https://static.example.com/templates/appendix.docx",
"optional": true
}
],
"uploaded": [
{
"contractId": "6789abcd",
"fileName": "customer_agreement.pdf",
"fileSize": 245760,
"contentType": "application/pdf",
"uploadedAt": "2026-03-20T10:30:00.000Z",
"state": "pending"
}
]
},
{
"type": "review",
"title": "Reviewing Documents",
"description": "Your documents are being reviewed."
},
{
"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