Sign in

v1

latestOpenAPI 3.0.12026-07-2427125325.2 KB
eligible

/eligible/v1

Validate nonprofit custom eligibility status of up to 25 organizations per call.

get/v1/{provider}

Path parameters

providerstring required
Example:apple

Provider's name to ensure respective eligibility criteria is applied.

Query parameters

einstring[] required

A comma separated array of strings of up to 25 eins

Response

OK

codeinteger

HTTP response status code.

messagestring[]

Array of diagnostic messages

tookinteger

Time taken for request to process

timestring

Current time of response

results_countinteger

Number of valid organizations returned

errorsstring[]

List of errors encountered

Example response

{
  "code": 200,
  "message": [
    "Request was processed successfully!"
  ],
  "took": 24,
  "time": "2022-09-09T11:23:20.000Z",
  "results_count": 1,
  "data": [
    {
      "organization_name": "Candid",
      "ein": "13-1837418",
      "eligibility_status": true,
      "eligibility_status_message": "Your organization is eligible.",
      "eligibility_checked_date": "2022-01-20T19:00:04Z",
      "profile_level": "Platinum",
      "profile_year": "2022",
      "profile_link": "https://www.guidestar.org/profile/13-1837418",
      "seal_last_modified": "2022-01-20T19:00:04Z",
      "website_url": "candid.org",
      "subsection_code": {
        "subsection_code": "03",
        "subsection_code_description": "501(c)(3) Public Charity"
      }
    }
  ]
}