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

# Verify a global donor magic link

> Consumes a global donor passwordless magic-link token from Redis. A valid token resolves the donor accounts cached for the email, deletes the token and clears the active verification challenge, then either completes donor login or returns an account-selection response. The endpoint also caches successful verification results for 60 seconds so repeated browser loads of the same link can return the same response.



## OpenAPI

````yaml get /frontend/global_donor/passwordless_verify/{token}
openapi: 3.0.0
info:
  title: Gratona API
  description: >-
    REST API for the Gratona fundraising platform, including donor, donation,
    sponsorship, program, event, and integration workflows. Endpoints are
    organized by tag. Most endpoints require either a Passport bearer token or
    an issued API key — see the Security Schemes section.
  contact:
    name: Gratona Engineering
    url: https://gratona.com
    email: devs@gratona.com
  version: 1.0.0
servers:
  - url: https://api.gratona.com/v1
    description: Server Version 1.0.0
security: []
tags:
  - name: Auth
    description: >-
      Login, signup, logout, password reset, and email verification for admin
      users and donors.
  - name: Donors
    description: >-
      Donor records: CRUD, profile fields, household linkage, search, filters,
      merge, and duplicate detection.
  - name: Donations
    description: >-
      Individual donation records, recurring commitments, soft credits, refunds,
      designations, and exports.
  - name: Sponsorships
    description: >-
      Donor-to-entity sponsorship relationships, lifecycle transitions, and
      sponsorship-specific filters.
  - name: Entities
    description: >-
      Recipient records (children, families, projects, animals, etc.), their
      status, and entity-level fields.
  - name: Programs
    description: >-
      Program / campaign configuration: hierarchy, settings, and program-level
      metadata.
  - name: Forms
    description: >-
      Custom form builder (HysForm), form fields, standardized donor fields, and
      field migrations.
  - name: Trips
    description: >-
      Mission-trip management: trips, participants, budgets, tasks,
      e-signatures, fundraising milestones, and background checks.
  - name: Communications
    description: >-
      Email templates, SMS, newsletters, donor email manager, and per-donor
      notes.
  - name: Payments
    description: >-
      Payment-gateway management (Stripe, PayPal, Flutterwave, QuickBooks).
      Excludes inbound webhooks — see the Webhooks tag.
  - name: Reports
    description: Dashboards, analytics, scheduled reports, and exports.
  - name: Admin
    description: >-
      Client-account administration: users, groups/permissions, settings,
      integrations, and account lifecycle.
  - name: Donor Portal
    description: >-
      Endpoints consumed by the donor-facing portal (donor login, dashboard,
      donation history, messages).
  - name: Recipient Portal
    description: Endpoints consumed by the recipient-facing portal.
  - name: Public
    description: >-
      Unauthenticated public endpoints: donor signup, public trip pages,
      peer-to-peer campaigns, public checkout.
  - name: Webhooks
    description: >-
      Inbound webhooks from third parties (Stripe, PayPal, Flutterwave, Checkr,
      DropboxSign). Annotated minimally for reference; payload shapes are owned
      by the upstream provider.
  - name: Client
    description: Client
  - name: Email Settings
    description: Email Settings
  - name: Admin Dashboard
    description: Admin Dashboard
  - name: Historical Archived Updates
    description: Historical Archived Updates
  - name: Team & access
    description: Team & access
  - name: Files
    description: Files
  - name: Wrapped
    description: Wrapped
  - name: Donor SignUp
    description: Donor SignUp
  - name: Frontend
    description: Frontend
  - name: User
    description: User
paths:
  /frontend/global_donor/passwordless_verify/{token}:
    get:
      tags:
        - Donor Portal
      summary: Verify a global donor magic link
      description: >-
        Consumes a global donor passwordless magic-link token from Redis. A
        valid token resolves the donor accounts cached for the email, deletes
        the token and clears the active verification challenge, then either
        completes donor login or returns an account-selection response. The
        endpoint also caches successful verification results for 60 seconds so
        repeated browser loads of the same link can return the same response.
      operationId: verifyGlobalDonorPasswordlessLogin
      parameters:
        - name: token
          in: path
          description: >-
            Random 64-character token from the global donor passwordless email.
            It is looked up under the `global_donor_passwordless:` Redis prefix.
          required: true
          schema:
            type: string
          example: 8b13d7f4c2e94b5fa0f2a0bb7b9359f469ac943f6bdc1eaaef23b7d75fc2e1ab
      responses:
        '200':
          description: >-
            Passwordless token verified; login completed or account selection is
            required.
          content:
            application/json:
              schema:
                properties:
                  status:
                    description: >-
                      `success` for completed login or `selection_required` for
                      multi-account emails.
                    type: string
                    example: success
                  message:
                    type: string
                    example: You have successfully logged in!
                  donor:
                    $ref: '#/components/schemas/Donor'
                  client:
                    $ref: '#/components/schemas/Client'
                  program_context:
                    type: object
                    nullable: true
                  redirect:
                    type: string
                    example: /frontend/donor_view/207/11/7f2c8f8d64b8a1d4a9e2
                    nullable: true
                  session_id:
                    type: string
                    example: 7f2c8f8d64b8a1d4a9e2
                    nullable: true
                  session_logged_in:
                    type: boolean
                    example: true
                    nullable: true
                  selection_token:
                    type: string
                    nullable: true
                  accounts:
                    type: array
                    items:
                      type: object
                    nullable: true
                type: object
        '400':
          description: Token was invalid, expired, or did not resolve to donors.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security: []
components:
  schemas:
    Donor:
      title: Donor
      description: >-
        A donor record. Donors give one-time donations and recurring
        commitments, and may be linked to entities (recipients) via
        sponsorships. Standardized profile columns (first_name, phone, address,
        etc.) coexist with arbitrary custom fields stored in `json_fields` and
        defined per `hysform_id`. The `username`/`email`/`password` columns also
        let donors sign in to the donor portal.
      required:
        - id
        - client_id
      properties:
        id:
          description: Internal donor ID.
          type: integer
          format: int64
          example: 12345
        client_id:
          description: >-
            Owning Gratona client (multi-tenant scope). All donor queries MUST
            filter by this.
          type: integer
          format: int64
          example: 207
        hysform_id:
          description: >-
            HysForm that defines this donor's profile fields (custom +
            standardized) — controls which keys appear in `json_fields`.
          type: integer
          format: int64
          example: 42
          nullable: true
        donorprogram_id:
          description: >-
            Program the donor signed up under, if applicable. Mostly
            informational.
          type: integer
          format: int64
          example: 11
          nullable: true
        household_id:
          description: >-
            Household this donor is linked to, when joint giving / partner
            records are tracked together.
          type: integer
          format: int64
          example: 88
          nullable: true
        type:
          description: >-
            Donor entity type. `organization` donors use `organization_name`
            instead of first/last.
          type: string
          enum:
            - individual
            - organization
          example: individual
          nullable: true
        username:
          description: >-
            Login username for the donor portal. Must be unique across donors
            when set.
          type: string
          example: janedoe
          nullable: true
        email:
          description: Donor email — used for receipts, statements, and donor-portal login.
          type: string
          format: email
          example: jane@example.com
          nullable: true
        organization_name:
          description: >-
            For `type=organization` donors. Standardized field; mirrored in
            `json_fields.organization` for legacy clients.
          type: string
          example: Acme Foundation
          nullable: true
        first_name:
          description: Donor first / given name. Standardized field.
          type: string
          example: Jane
          nullable: true
        last_name:
          description: Donor last / family name. Standardized field.
          type: string
          example: Doe
          nullable: true
        preferred_contact_method:
          description: How the donor prefers to be contacted.
          type: string
          enum:
            - email
            - phone
            - sms
            - mail
          example: email
          nullable: true
        phone:
          description: Phone number as entered by the user (display format).
          type: string
          example: (555) 123-4567
          nullable: true
        phone_e164:
          description: >-
            Phone normalized to E.164 for SMS/dialing. Populated by the phone
            normalization pipeline.
          type: string
          example: '+15551234567'
          nullable: true
        can_receive_sms:
          description: Whether SMS opt-in is granted for this donor.
          type: boolean
          example: true
        street:
          description: Street address line 1 (standardized).
          type: string
          example: 123 Main St
          nullable: true
        address_line2:
          description: Street address line 2 (apartment, unit, suite).
          type: string
          example: Apt 4B
          nullable: true
        city:
          description: City.
          type: string
          example: Springfield
          nullable: true
        state:
          description: State / region (free-form display value).
          type: string
          example: IL
          nullable: true
        zip:
          description: Postal / ZIP code.
          type: string
          example: '62704'
          nullable: true
        country:
          description: Country display name.
          type: string
          example: United States
          nullable: true
        country_code:
          description: ISO 3166-1 alpha-2 country code.
          type: string
          example: US
          nullable: true
        subdivision_code:
          description: ISO 3166-2 country subdivision code.
          type: string
          example: US-IL
          nullable: true
        json_fields:
          description: >-
            Arbitrary custom fields keyed by `hysform_id` configuration. Values
            are typically strings, but checkbox / multi-select fields may be
            arrays. Use `hysform_id` to look up the field definitions.
          type: object
          nullable: true
          additionalProperties: true
        year_to_date:
          description: >-
            Cached YTD giving totals (per year and per program), refreshed by
            background jobs.
          type: object
          nullable: true
          additionalProperties: true
        has_artifacts:
          description: Whether the donor has any uploads/photos attached.
          type: boolean
          example: false
        batch_id:
          description: >-
            Set when the donor was created via a CSV import batch; ties together
            donors imported in the same run.
          type: integer
          format: int64
          example: null
          nullable: true
        created_at:
          type: string
          format: date-time
          example: '2025-03-15T19:42:00Z'
        updated_at:
          type: string
          format: date-time
          example: '2026-01-02T08:11:00Z'
        deleted_at:
          description: >-
            Soft-delete timestamp; donors with a non-null value are excluded
            from default queries.
          type: string
          format: date-time
          example: null
          nullable: true
      type: object
    Client:
      title: Client
      description: >-
        A Gratona client — the tenant of the multi-tenant system. Owns donors,
        entities, programs, users, and integrations. The `client_id` on every
        other resource scopes data to this row. Stripe Connect onboarding state,
        account-level settings, and the client's display name all live here.
      required:
        - id
        - organization
      properties:
        id:
          description: Internal client ID — referenced by every multi-tenant resource.
          type: integer
          format: int64
          example: 207
        organization:
          description: Display name of the organization.
          type: string
          example: Gratona Demo Org
        website:
          description: Organization website.
          type: string
          example: https://demo.gratona.com
          nullable: true
        email:
          description: Primary contact email for the organization.
          type: string
          format: email
          example: hello@demo.gratona.com
          nullable: true
        stripe_connect_id:
          description: >-
            Stripe Connect account id once onboarding completes; null until the
            org has finished Stripe onboarding.
          type: string
          example: acct_1OqXXXXX
          nullable: true
        previous_stripe_connect_id:
          description: >-
            Prior Stripe Connect account id, kept around when the client
            migrates between Connect accounts.
          type: string
          example: null
          nullable: true
        completed_stripe_onboarding:
          description: >-
            Whether the org has finished the Stripe Connect onboarding flow and
            can accept Stripe payments.
          type: boolean
          example: true
        date_format:
          description: >-
            Stored organization date-format setting token. API and admin
            surfaces resolve this token to the corresponding display pattern.
          type: string
          enum:
            - m-d-Y
            - d-m-Y
            - Y-m-d
          example: Y-m-d
        timezone:
          description: 'Computed accessor: client timezone derived from settings.'
          type: string
          example: America/Chicago
          nullable: true
        custom:
          description: >-
            Legacy free-form JSON column for arbitrary client-level
            configuration.
          type: object
          nullable: true
          additionalProperties: true
        frequency:
          description: Legacy frequency configuration for billing / payment plans (JSON).
          type: object
          nullable: true
          additionalProperties: true
        custom_start_date:
          description: Legacy billing custom start date marker.
          type: string
          example: null
          nullable: true
        custom_amount:
          description: Legacy billing custom amount marker.
          type: number
          format: float
          example: null
          nullable: true
        created_at:
          type: string
          format: date-time
          example: '2024-06-01T12:00:00Z'
        updated_at:
          type: string
          format: date-time
          example: '2026-01-01T00:00:00Z'
      type: object
    ErrorResponse:
      title: ErrorResponse
      description: >-
        Generic error envelope used by most controllers. Most error responses
        pair a human-readable `message` with `status: error`. Some endpoints
        additionally include `errors` (validator errors), `error` (legacy
        single-error string), `code`, or domain-specific context fields.
      required:
        - message
      properties:
        message:
          description: Human-readable error message.
          type: string
          example: Something went wrong. Please try again.
        status:
          description: >-
            Always the literal string `error` for failures. Some endpoints omit
            this field.
          type: string
          example: error
        error:
          description: Legacy single error code/string used by older endpoints.
          type: string
          example: invalid_request
          nullable: true
        code:
          description: >-
            Optional application-level error code (not all endpoints populate
            this).
          type: string
          example: DONOR_NOT_FOUND
          nullable: true
      type: object

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.