Skip to navigation
Core ResourcesOrganizations

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.

Sandbox Only

This API is only available in the sandbox environment.

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

OK
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