Sandbox: Onboard an organization

curl -X POST https://api.givechariot.com/v1/simulations/organizations/onboard/org_1LaXpKGUcADgqoEMl0Cx0Ygg \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "settlement": "SANDBOX_SETTLEMENT_ACCOUNT_TRANSFER"
}'

{
  "id": "org_01jpjenf5q6cawy43yxfcrxhct",
  "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",
    "line2": "string"
  },
  "classification": {
    "group_exemption_number": "string",
    "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,
      "reason": "string",
      "last_found_at": "2020-01-31T23:00:00Z"
    },
    "ofac": {
      "compliant": true,
      "reason": "string",
      "last_found_at": "2020-01-31T23:00:00Z"
    },
    "foundation_code": {
      "compliant": true,
      "reason": "string",
      "last_found_at": "2020-01-31T23:00:00Z"
    },
    "california_attorney_general_registry": {
      "compliant": true,
      "reason": "string",
      "last_found_at": "2020-01-31T23:00:00Z"
    },
    "california_franchise_tax_board": {
      "compliant": true,
      "reason": "string",
      "last_found_at": "2020-01-31T23:00:00Z"
    }
  },
  "mission_statement": "To provide relief to those in need",
  "web": {
    "domain": "redcross.org"
  },
  "brand": {
    "icon_url": "string",
    "logo_url": "string"
  },
  "officers": [
    {
      "name": "string",
      "title": "Executive Director"
    }
  ],
  "claimed": true,
  "incorporation": {
    "formation_year": "2005",
    "state": "AZ",
    "ruling_date": "2020-07"
  }
}

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.

Sandbox Only

This API is only available in the sandbox environment.

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>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

The unique identifier for the organization to onboard.

Request

This endpoint expects an object.

settlementenumRequired

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.

Allowed values:

Response headers

X-Request-IdstringOptional

The unique identifier for the request

Response

idstringRead-only

The unique identifier for the object.

einstring

The EIN of the organization.

namestring

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_idstringOptional

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.

physical_addressobjectOptional

classificationobjectOptional

A classification of the nonprofit entity as defined by the IRS.

complianceobjectOptional

An object that contains legal information about the nonprofit entity and its tax-exemption status. This information is used to comply with regulations and ensure the legitimacy of the nonprofit for purposes of donations and disbursements.

mission_statementstringOptional

The mission statement of the organization

webobjectOptional

A web domain is a unique identifier for a website or web application that is associated with an organization. Domains are important identity constructs that underpin the web and online interactions. The domain can be used as an identifier and its validity can be asserted via DNS.

brandobjectOptional

Fair use brand assets that are associated with an organization and can be used for identification and informational purposes.

officerslist of objectsOptional

The list of officers of the organization

claimedbooleanOptionalRead-only

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.

incorporationobjectOptional

Incorporation and IRS determination information for the nonprofit entity.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error