Connect your customer journey to GOFA and return safely to your product.
Your application owns customer sign-in and the return page. GOFA hosts the service experience, collects its inputs, and saves the result. The API key stays on your backend throughout the journey.
After creating an Inquiry, open the returned launchUrl
in a top-level browser. Preserve the complete URL, including #token=…. Do not
construct your own URL, put your API key in it, or strip the fragment.
Use a browser that can grant camera access for Vital Scan. Test the actual mobile browser your users will use; an embedded in-app browser can have different camera permissions. This guide covers top-level redirection, not an iframe or embedded SDK integration.
The welcome page includes the service declaration and privacy information. The user confirms these before proceeding. GOFA records the declaration version, language, and confirmation time for the assessment.
Open Inquiries → Services, then choose Vital Scan or AI Nutrition. Configure the available branding, welcome content, completion content, and default return URL for that service. Changes to one service do not configure the other. GOFA continues to own the assessment steps; this is not a workflow builder.
Create a new Inquiry to test configuration changes. Existing Inquiries keep the service configuration captured when they were created.
| Setting | Purpose |
|---|---|
| Organization → Domains | Approves which website origins may receive users. Shared across services. |
| Service default return URL | Chooses the normal destination for that service. |
API returnUrl | Overrides the default for one new Inquiry. |
Use HTTPS. The URL must not contain embedded credentials or a fragment. Query parameters are allowed. An origin allowlist approves the destination; it does not select a page by itself.
If neither the API nor the service supplies a return URL, the Hosted Flow has no configured enterprise destination. Configure one before end-to-end testing.
For a configured URL such as:
https://uat.example.com/assessments/return?source=wellnessGOFA adds or replaces inquiry_id while preserving the other query parameters:
https://uat.example.com/assessments/return?source=wellness&inquiry_id=01234567-89ab-4cde-8fab-0123456789abNo result or completion status is added to this URL. The user returns through the Hosted Flow's return action; do not depend on an automatic completion redirect.
Your return handler should:
inquiry_id and verify ownership against the mapping saved at creation.A redirect is not proof of completion
A user can return after completing, pausing, or failing an assessment. Always use the API status. A query-string change must never grant access to another customer's result.
Keep the Inquiry ID in your own records. If an unfinished task needs a fresh access link, check whether it is eligible for a new session. A new session does not extend the task's deadline or create another result.
For an expired task, offer an explicit new assessment instead of silently creating one during a page refresh. See Lifecycle and retries.