> ## Documentation Index
> Fetch the complete documentation index at: https://docs.thefaithapp.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Hosted Auth URL

> Creates a TheFaithApp-hosted sign-in URL for the church identified by the client key. Open the returned auth_url in a browser or mobile auth session.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/auth/start
openapi: 3.1.0
info:
  title: TheFaithApp Partner API
  version: 1.0.0
  description: >-
    The v1 API for third-party apps that sign in TheFaithApp members and access
    church-scoped content and workflows.
  contact:
    name: TheFaithApp Support
    email: support@thefaithapp.com
servers:
  - url: https://api.thefaithapp.com
    description: Production
security:
  - apiKeyAuth: []
    bearerAuth: []
tags:
  - name: Hosted Auth
    description: Sign members in through the hosted TheFaithApp authentication flow.
  - name: Core Experience
    description: Load member context and the personalized home experience.
  - name: Content
    description: >-
      Read sermons, media, YouTube videos, devotionals, and streaming
      configuration.
  - name: Engagement
    description: Manage member favorites and devotional bookmarks.
  - name: Churches
    description: Read church profiles, public directory records, and branch information.
  - name: Events & Volunteers
    description: >-
      Browse events and volunteer opportunities, then manage registrations and
      commitments.
  - name: Notifications & Bulletins
    description: Read church and member notifications and published bulletins.
  - name: Prayer
    description: Submit a prayer request for the authenticated member.
  - name: Member Connections
    description: Manage the member’s campus and ministry connections.
  - name: Community Groups
    description: >-
      Discover groups and manage membership, feeds, attendance, study guides,
      and leader notes.
  - name: Community Preferences & Research
    description: >-
      Manage community preferences, summaries, and consent-based research
      participation.
  - name: Resource Sharing
    description: Offer shared resources and manage member loan requests and transitions.
  - name: Mutual Aid
    description: >-
      Manage needs and offers, private responses, safety reports, and member
      activity.
  - name: Analytics
    description: Record product analytics events and retrieve aggregate metrics.
  - name: Notification Analytics
    description: Record and summarize notification delivery, open, and click events.
paths:
  /v1/auth/start:
    post:
      tags:
        - Hosted Auth
      summary: Create Hosted Auth URL
      description: >-
        Creates a TheFaithApp-hosted sign-in URL for the church identified by
        the client key. Open the returned auth_url in a browser or mobile auth
        session.
      operationId: postAuthStart
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                client_key:
                  type: string
                  description: Client key copied from Developer Access.
                  example: your-client-api-key
                redirect_uri:
                  type: string
                  format: uri
                  description: Saved Redirect URL that will receive the one-time code.
                  example: https://example.com/auth/callback
                state:
                  type: string
                  description: >-
                    Random value generated by your app and verified when the
                    member returns.
                  example: replace-with-random-state
                code_challenge:
                  type: string
                  description: Optional PKCE code challenge for public clients.
                  example: base64url-sha256-code-verifier
                code_challenge_method:
                  type: string
                  description: PKCE challenge method. Use S256 when sending code_challenge.
                  enum:
                    - S256
                  example: S256
              required:
                - client_key
                - redirect_uri
      responses:
        '200':
          description: Hosted sign-in URL created.
          content:
            application/json:
              schema:
                type: object
                properties:
                  auth_url:
                    type: string
                    format: uri
                    example: >-
                      https://auth.thefaithapp.com/member/sign-in?client_key=your-client-api-key&redirect_uri=https%3A%2F%2Fexample.com%2Fauth%2Fcallback&state=replace-with-random-state
                  client:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 45
                      name:
                        type: string
                        example: Example Church
                      image:
                        type:
                          - string
                          - 'null'
                        example: clients/example-logo.png
                      image_url:
                        type:
                          - string
                          - 'null'
                        format: uri
                        example: https://cdn.example.com/clients/example-logo.png
                      about:
                        type:
                          - string
                          - 'null'
                        example: null
                      public_uuid:
                        type: string
                        example: 11111111-2222-3333-4444-555555555555
                  redirect_uri:
                    type: string
                    format: uri
                    example: https://example.com/auth/callback
                  providers:
                    type: array
                    items:
                      type: string
                    example:
                      - google
                      - apple
                      - email
        '403':
          description: Redirect URL is not saved for this client key.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Redirect URL is not allowed for this client.
                  error:
                    type: string
                    example: Redirect URL is not allowed for this client.
                  errors:
                    type: object
        '404':
          description: Client key was not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Client not found.
                  error:
                    type: string
                    example: Client not found.
                  errors:
                    type: object
        '422':
          description: Validation error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The redirect uri field is required.
                  error:
                    type: string
                    example: The redirect uri field is required.
                  errors:
                    type: object
      security: []
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Client API key copied from Developer Access in the TheFaithApp
        dashboard.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum
      description: Member access token returned by `POST /v1/auth/token`.

````