Create an Inquiry

POST /api/platform/v1/inquiries

Requires inquiries:create. No query parameters are accepted. Send a JSON object within the 4,096-byte request limit.

Headers

Body

Unknown fields are rejected. Do not send userId, locale, templateId, health information, or image data here. The user provides service inputs inside GOFA.

curl --request POST 'https://www.uat.gofa.app/api/platform/v1/inquiries' \
  --header "Authorization: Bearer $GOFA_API_KEY" \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: vital-request-0001' \
  --data '{"workflowId":"vital-scan","referenceId":"member_7f32a","returnUrl":"https://uat.example.com/assessments/return"}'

Response

201 Created, with this data structure:

See Quick start for a full response example. The Inquiry and initial session expire 24 hours after creation. Creation alone does not deduct assessment credits.

Idempotency

GOFA stores creation outcomes for 24 hours, scoped to your enterprise and test environment. Retrying the same request with the same idempotency key returns the original creation response. A successful replay is still 201, with Idempotency-Replayed: true; the first successful request returns false.

• Keep the request body and API origin the same when retrying.
• Reusing an unexpired key with different request content returns 409 conflict.
• A replay is the original response, not the current task status. Use GET to read progress.
• The saved response includes the original session URL. Replaying does not renew its expiry or undo session revocation.
• Some business-validation failures are also retained once creation processing begins. Repeating the same key after changing configuration can replay that failure. After confirming no Inquiry was created, use a new key for a new attempt.
• After the 24-hour retention window, do not rely on the key to suppress a duplicate. Keep your own request-to-Inquiry mapping.

A double-click and a network retry for the same assessment should share one key. A later intentional assessment for the same customer needs a new key. The customer's referenceId is not an idempotency key.