DOCSEARCHbyAlgolia
Submit Docs

Goodstack API Documentation

website·Indexed 36 days ago

https://docs.goodstack.io

API documentation for Goodstack services, including endpoints for managing donations, agent and monetary donation verifications, eligibility and monitoring subscriptions, validation requests, and webhook subscriptions.

Tokens
28.7K
Snippets
156
Records
257
Agent score
59%

What's inside Goodstack

  1. Overview of Education Verification API

    The Education Verification API allows developers to verify if applicants are associated with recognized educational institutions to gate discounts and offers. It supports two primary personas: Students (focused on higher education like universities and colleges) and Teachers (primarily K-12, with some higher education coverage). Each verification submission undergoes three checks: a Validation Request (institution legitimacy), an Eligibility Check (institution type), and an Agent Verification (applicant's association with the institution).

  2. Overview of the Nonprofit Verification API flow

    The Goodstack API allows developers to build a custom nonprofit verification experience. The typical integration journey consists of:

    1. Searching for an existing organization.
    2. Handling manual-entry paths if the organization is not found.
    3. Creating a validation submission from the backend.
    4. Collecting required supporting documents.
    5. Translating submission states into user actions.
    6. Receiving webhooks to reconcile the final verification result.

  5. Authenticate and use the SCIM 2.0 API

    Goodstack provides a SCIM 2.0 compliant API for provisioning and managing users. All endpoints under /scim/v2 require a partner SCIM API key passed as a bearer token. The authenticated partner must have the scim_api scope. API responses use the application/scim+json media type.

  6. List supported SCIM resource types

    Use the /scim/v2/ResourceTypes endpoint to discover supported resource types. The User resource type includes information about the Enterprise User and Goodstack User extensions within the schemaExtensions field. A 401 error indicates a missing/invalid bearer key or that the partner lacks the scim_api scope.
    GET /scim/v2/ResourceTypes

  7. Verify user association with a nonprofit using Agent Verification

    Agent Verification prevents program abuse by confirming a user is associated with the nonprofit they claim to represent and is authorized to receive donations. The process consists of two parts:

    1. Nonprofit Association (Core): Goodstack determines association either automatically (comparing the user's email domain to the nonprofit's website domain) or manually (contacting the nonprofit via email for confirmation).
    2. User Verification (Optional): Goodstack verifies the user has access to the email address used for the application. This is recommended if the partner does not perform their own email verification or if the product account email differs from the Goodstack verification email.

  8. Manage Donation Sessions

    Donation Sessions are used to facilitate the donation process. Available operations include listing all sessions, retrieving a specific session, and updating donor details (such as email address, name, consent preferences, and gift notes) for any donations linked to a specified session. To create a new Donation Session, you must provide the organisationId of the target nonprofit.

  9. Choose between Goodstack API and Hosted Donation Gateway

    Goodstack offers two primary integration paths for monetary donations:

    1. API Setup: Best for building a fully custom donation experience within your own product. You handle the payments yourself, while Goodstack tracks donations and handles disbursement to nonprofits.
    2. Hosted Setup: A faster implementation using the Goodstack Hosted Donation Gateway, which handles more of the heavy lifting for the donation experience.

  10. Choose a verification and donation workflow

    Goodstack provides two primary integration paths: Hosted guides for fast deployment with minimal front-end work, and API guides for full control over the user experience. Available workflows include:

    • Hosted nonprofit verification: Use Goodstack-hosted screens to verify organizations.
    • Nonprofit verification API: Build a custom verification flow for nonprofit eligibility.
    • Education verification API: Verify students and teachers using a custom UI.
    • Hosted donations: Use Goodstack-hosted checkout and confirmation pages.
    • Donations API: Build a custom donation experience and process payments through Goodstack.

  11. Handle Agent Verification webhook events

    Goodstack triggers specific webhook events to notify you of the status of an agent's verification process. The available events are:

    • Agent verification pending user verification: The agent passed Goodstack review and is now awaiting email verification.
    • Agent verification pending review: The agent passed email verification and is now awaiting review by Goodstack.
    • Agent verification was approved: The agent verification has been officially approved by Goodstack.
    • Agent verification was rejected: The agent verification has been rejected by Goodstack.