Sign in

v31

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-215985245.8 KB
Organizations

Sandbox: Onboard an organization

Creates a Chariot account for a sandbox recipient organization so that disbursements to it settle electronically instead of via a mailed check.

By default a sandbox organization has no Chariot account, so disbursements to it are mailed as a physical check. Call this endpoint to provision an account for the organization and choose which electronic rail its disbursements should settle on.

The settlement is fixed on the first successful call. Onboarding the same organization again with a different settlement returns an error.

<Note title="Sandbox Only" icon="fa-light fa-atom-simple"> This API is only available in the sandbox environment. </Note>
post/v1/simulations/organizations/onboard/{id}

Path parameters

idstring required

The unique identifier for the organization to onboard.

Request body

settlement'SANDBOX_SETTLEMENT_ACCOUNT_TRANSFER' | 'SANDBOX_SETTLEMENT_ACH' required

The electronic rail on which disbursements to an onboarded sandbox organization settle. SANDBOX_SETTLEMENT_ACCOUNT_TRANSFER settles as an in-network transfer between accounts on the same bank. SANDBOX_SETTLEMENT_ACH settles via ACH across banks.

Response

OK

idstring required

The unique identifier for the object.

einstring required

The EIN of the organization.

namestring required

The name of the organization. For organizations that operate under a different name than the one tied to the legal entity, this name will differ from the name of the linked entity. This is also known as the "DBA" or "Doing Business As" name of the organization.

parent_organization_idstring

The unique identifier of the parent organization, if this is a sponsored organization. This value is null or empty if the organization is not sponsored or not a child of a parent organization.

mission_statementstring

The mission statement of the organization

claimedboolean

A flag to indicate if the nonprofit has been claimed by a user. A nonprofit is claimed if a user signs up for a Chariot account with this nonprofit and is verified by the Chariot team.

Example response

{
  "id": "org_01j8rs605a4gctmbm58d87mvsj",
  "ein": "123456789",
  "name": "American Red Cross",
  "parent_organization_id": "org_01j8rs605a4gctmbm58d87mvsk",
  "physical_address": {
    "city": "New York",
    "country": "US",
    "line1": "123 Main St.",
    "postal_code": "12345",
    "state": "NY"
  },
  "classification": {
    "subsection_code": {
      "code": 1,
      "name": "UNCONDITIONAL",
      "description": "Unconditional Exemption"
    },
    "filing_requirement_code": {
      "code": 1,
      "name": "UNCONDITIONAL",
      "description": "Unconditional Exemption"
    },
    "foundation_code": {
      "code": 1,
      "name": "UNCONDITIONAL",
      "description": "Unconditional Exemption"
    },
    "affiliation_code": {
      "code": 1,
      "name": "UNCONDITIONAL",
      "description": "Unconditional Exemption"
    },
    "organization_code": {
      "code": 1,
      "name": "UNCONDITIONAL",
      "description": "Unconditional Exemption"
    },
    "exempt_status_code": {
      "code": 1,
      "name": "UNCONDITIONAL",
      "description": "Unconditional Exemption"
    },
    "deductibility_code": {
      "code": 1,
      "name": "UNCONDITIONAL",
      "description": "Unconditional Exemption"
    },
    "ntee_code": {
      "code": "A",
      "description": "Animal Welfare",
      "parent_code": "A",
      "parent_description": "Animal Welfare"
    },
    "naics_code": {
      "naics2": "31",
      "naics2_description": "Manufacturing",
      "naics4": "3112",
      "naics4_description": "Grain and Oilseed Milling",
      "naics6": "311221",
      "naics6_description": "Wet Corn Milling and Starch Manufacturing"
    }
  },
  "compliance": {
    "daf_eligible": true,
    "irs_pub_78": {
      "compliant": true,
      "last_found_at": "2020-01-31T23:00:00Z"
    },
    "ofac": {
      "compliant": true,
      "last_found_at": "2020-01-31T23:00:00Z"
    },
    "foundation_code": {
      "compliant": true,
      "last_found_at": "2020-01-31T23:00:00Z"
    },
    "california_attorney_general_registry": {
      "compliant": true,
      "last_found_at": "2020-01-31T23:00:00Z"
    },
    "california_franchise_tax_board": {
      "compliant": true,
      "last_found_at": "2020-01-31T23:00:00Z"
    }
  },
  "mission_statement": "To provide relief to those in need",
  "web": {
    "domain": "redcross.org"
  },
  "officers": [
    {
      "title": "Executive Director"
    }
  ],
  "incorporation": {
    "formation_year": "2005",
    "state": "AZ",
    "ruling_date": "2020-07"
  }
}