# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Native Journey API
  version: 1.0.0
extends: openapi/strivacity-native-journey-api-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 23
- target: $.paths['/flow/api/v1/form/additionalActions/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Perform an additional action in a login journey
      effect: write
      questions:
      - Can a customer in a native login journey trigger forgot-password or forgot-username from the form?
      - What happens when a user picks an additional action like forgotten username mid-journey?
      instructions:
      - text: Submit the additional action {id} from the native journey form.
        slots:
          id: path.id
      - text: Trigger additional journey action {id}, such as forgotten password.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flow/api/v1/form/customerInput'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit customer input collected in a journey
      effect: write
      questions:
      - How do I post the attributes a customer filled in on the customer input step of a journey?
      - Can I send locale data along with the customer input form values?
      instructions:
      - text: 'Store these customer input attributes for the journey: {attributes}.'
        slots:
          attributes: requestBody.attributes
      - text: Submit the customer input step with local data {local}.
        slots:
          local: requestBody.local
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flow/api/v1/form/externalLoginProvider/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Choose an external login provider in a journey
      effect: write
      questions:
      - Can a native journey hand the user off to an external login provider they picked?
      - Which form do I post when the customer chooses social or enterprise sign-in?
      instructions:
      - text: Continue the journey with external login provider {id}.
        slots:
          id: path.id
      - text: Select external sign-in option {id} on the login form.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flow/api/v1/form/forgottenPasswordEmail'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a forgotten password email
      effect: write
      questions:
      - Can my custom login screen send a password reset email through the native flow?
      - What triggers the forgotten password email in a hosted journey?
      instructions:
      - text: Send the forgotten password email for the current journey.
      - text: Email the customer a password recovery link from the native flow.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flow/api/v1/form/forgottenPasswordPhone'].post
  update:
    x-apievangelist-phrasing:
      intent: Start password recovery via phone
      effect: write
      questions:
      - Is it possible to recover a password with phone verification instead of email?
      - Can the phone-based password recovery code be delivered by voice call?
      instructions:
      - text: Start phone-based password recovery for this journey.
      - text: Start password recovery by phone with voice delivery set to {voice}.
        slots:
          voice: requestBody.voice
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flow/api/v1/form/forgottenUsername'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a forgotten username reminder
      effect: write
      questions:
      - What does a user need to provide to get a forgotten username reminder?
      - Can my native login page send a username reminder to the customer?
      instructions:
      - text: Send a username reminder to {recipient}.
        slots:
          recipient: requestBody.recipient
      - text: Remind {recipient} of their username from the login journey.
        slots:
          recipient: requestBody.recipient
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flow/api/v1/form/genericAction/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a generic action in a journey
      effect: write
      questions:
      - Can I post a custom action button from a native journey screen?
      - Which endpoint handles a generic action form in a login flow?
      instructions:
      - text: Submit generic journey action {id}.
        slots:
          id: path.id
      - text: Run custom form action {id} in the current native flow.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flow/api/v1/form/genericResult'].post
  update:
    x-apievangelist-phrasing:
      intent: Continue a journey from a result screen
      effect: write
      questions:
      - How do I move a native flow past a generic result screen?
      - What do I post to continue after an informational result step in a journey?
      instructions:
      - text: Continue the journey from the generic result screen.
      - text: Acknowledge the result step and advance the native flow.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flow/api/v1/form/identifier'].post
  update:
    x-apievangelist-phrasing:
      intent: Identify an account in a login journey
      effect: write
      questions:
      - Can a native login screen remember the account identifier for next time?
      - What is the first step to identify a user by email or username in a journey?
      instructions:
      - text: Identify the account {identifier} in the login journey.
        slots:
          identifier: requestBody.identifier
      - text: 'Submit identifier {identifier} and remember the account: {rememberAccount}.'
        slots:
          identifier: requestBody.identifier
          rememberAccount: requestBody.rememberAccount
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flow/api/v1/form/mfaEnrollChallenge'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify the passcode to finish MFA enrollment
      effect: write
      questions:
      - How do I confirm a new authenticator during MFA enrollment with the code the user received?
      - Can the device be remembered after finishing MFA enrollment?
      instructions:
      - text: Complete MFA enrollment with passcode {passcode}.
        slots:
          passcode: requestBody.passcode
      - text: 'Verify enrollment passcode {passcode} and remember device: {rememberDevice}.'
        slots:
          passcode: requestBody.passcode
          rememberDevice: requestBody.rememberDevice
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flow/api/v1/form/mfaEnrollStart'].post
  update:
    x-apievangelist-phrasing:
      intent: Start MFA enrollment
      effect: write
      questions:
      - Which authenticator types can a customer choose when starting MFA enrollment?
      - Can I mark some authenticators as mandatory and others optional at enrollment start?
      instructions:
      - text: Start MFA enrollment with mandatory authenticators {mandatory}.
        slots:
          mandatory: requestBody.mandatory
      - text: Begin enrolling optional authenticators {optional} for this customer.
        slots:
          optional: requestBody.optional
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flow/api/v1/form/mfaEnrollTargetSelect'].post
  update:
    x-apievangelist-phrasing:
      intent: Choose the target for MFA enrollment
      effect: write
      questions:
      - What target and delivery method does a user pick when enrolling a phone or email authenticator?
      - Can enrollment send the code by SMS to a phone number the user enters?
      instructions:
      - text: Enroll {target} as the MFA target using method {method}.
        slots:
          target: requestBody.target
          method: requestBody.method
      - text: Select {target} with {method} delivery for MFA enrollment.
        slots:
          target: requestBody.target
          method: requestBody.method
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flow/api/v1/form/mfaMethod'].post
  update:
    x-apievangelist-phrasing:
      intent: Select an MFA method during login
      effect: write
      questions:
      - When a user has several second factors, how is the one used for this login chosen?
      - Can the user pick an MFA method and skip it on this device next time?
      instructions:
      - text: Use MFA method {id} for this sign-in.
        slots:
          id: requestBody.id
      - text: 'Choose two-factor method {id} and remember device: {rememberDevice}.'
        slots:
          id: requestBody.id
          rememberDevice: requestBody.rememberDevice
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flow/api/v1/form/mfaPasscode'].post
  update:
    x-apievangelist-phrasing:
      intent: Authenticate with an MFA passcode
      effect: write
      questions:
      - How do I submit the one-time code a user enters at the two-factor step of login?
      - Does entering the MFA passcode let me remember the device?
      instructions:
      - text: Authenticate with MFA passcode {passcode}.
        slots:
          passcode: requestBody.passcode
      - text: 'Submit login passcode {passcode} and remember this device: {rememberDevice}.'
        slots:
          passcode: requestBody.passcode
          rememberDevice: requestBody.rememberDevice
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flow/api/v1/form/password'].post
  update:
    x-apievangelist-phrasing:
      intent: Authenticate with a password
      effect: write
      questions:
      - Can a native login screen sign the user in with their password and keep them logged in?
      - What gets posted at the password step of a Strivacity login journey?
      instructions:
      - text: Sign in with password {password}.
        slots:
          password: requestBody.password
      - text: 'Authenticate using password {password} and keep me logged in: {keepMeLoggedIn}.'
        slots:
          password: requestBody.password
          keepMeLoggedIn: requestBody.keepMeLoggedIn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flow/api/v1/form/passwordEnroll'].post
  update:
    x-apievangelist-phrasing:
      intent: Enroll a password during a journey
      effect: write
      questions:
      - Can a user without a password set one up during a login journey?
      - Is password confirmation needed when enrolling a first password in the flow?
      instructions:
      - text: Enroll new password {password} for this account.
        slots:
          password: requestBody.password
      - text: Set up password {password}, confirmed as {passwordConfirmation}.
        slots:
          password: requestBody.password
          passwordConfirmation: requestBody.passwordConfirmation
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flow/api/v1/form/passwordReset'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset a customer's password
      effect: write
      questions:
      - What does the final step of a password reset look like in the native flow?
      - Can the reset form include a confirmation of the new password?
      instructions:
      - text: Reset the customer's password to {password}.
        slots:
          password: requestBody.password
      - text: Change the password to {password} with confirmation {passwordConfirmation}.
        slots:
          password: requestBody.password
          passwordConfirmation: requestBody.passwordConfirmation
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flow/api/v1/form/progressiveProfiling'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit progressive profiling data
      effect: write
      questions:
      - Can I collect extra profile details and consents from returning users during login?
      - Where do progressive profiling answers get posted in a journey?
      instructions:
      - text: Save progressive profiling attributes {attributes}.
        slots:
          attributes: requestBody.attributes
      - text: Record the consents {consents} given at progressive profiling.
        slots:
          consents: requestBody.consents
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flow/api/v1/form/proofingData'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit identity verification data
      effect: write
      questions:
      - Can I temporarily store data a user enters during identity verification in a journey?
      - Where do identity proofing form values get submitted?
      instructions:
      - text: Store identity verification data {attributes} for this flow.
        slots:
          attributes: requestBody.attributes
      - text: Submit proofing attributes {attributes} collected from the customer.
        slots:
          attributes: requestBody.attributes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flow/api/v1/form/registration'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a new customer account
      effect: write
      questions:
      - How do I register a new customer through a native sign-up journey?
      - Which details can a registration form submit — email, phone, username, consents?
      instructions:
      - text: Register a new account with email {email} and password {password}.
        slots:
          email: requestBody.email
          password: requestBody.password
      - text: Sign up user {userName} with phone {phone}.
        slots:
          userName: requestBody.userName
          phone: requestBody.phone
      - text: Submit registration attributes {attributes} with consents {consents}.
        slots:
          attributes: requestBody.attributes
          consents: requestBody.consents
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flow/api/v1/form/reset'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset a journey to its initial state
      effect: write
      questions:
      - Can I restart a native login journey from the beginning?
      - What happens to the flow state if the user hits start over?
      instructions:
      - text: Reset this login flow to its initial state.
      - text: Start the native journey over from the first screen.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flow/api/v1/form/sendAccountActivation'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an account activation
      effect: write
      questions:
      - Can a user ask for the account activation message to be sent again during login?
      - Is there a form action that sends an account activation?
      instructions:
      - text: Send the account activation for this journey.
      - text: Resend the activation message to the customer from the native flow.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flow/api/v1/init'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a native login flow
      effect: write
      questions:
      - What do I call to get the first screen of a native login flow?
      - Where does my app fetch the data to render the initial journey screen?
      instructions:
      - text: Initialize a native login flow.
      - text: Fetch the initial screen data for a new journey.
      method: generated
      generated: '2026-10-01'