{"openapi":"3.0.1","info":{"title":"Nonprofit Eligibility API","description":"Verify a nonprofit's eligibility to receive donations through Apple Pay.","license":{"name":"Candid API License Agreement"},"version":"1.0"},"tags":[{"name":"Custom eligibility status of nonprofits"}],"servers":[{"url":"https://api.candid.org/eligible","description":"Production Server"}],"paths":{"/v1/{provider}":{"get":{"tags":["eligible"],"description":"Validate nonprofit custom eligibility status of up to 25 organizations per call.","operationId":"eligible","summary":"/eligible/v1","parameters":[{"name":"provider","in":"path","description":"Provider's name to ensure respective eligibility criteria is applied.","required":true,"schema":{"type":"string","example":"apple"}},{"name":"ein","in":"query","explode":false,"description":"A comma separated array of strings of up to 25 eins","required":true,"schema":{"type":"array","items":{"type":"string","example":["56-2618866","13-1837418"]}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP response status code.","example":200},"message":{"type":"array","description":"Array of diagnostic messages","items":{"description":"Diagnostic message for response status","example":"Request was processed successfully!"}},"took":{"type":"integer","description":"Time taken for request to process","example":24},"time":{"type":"string","description":"Current time of response","example":"2022-09-09T11:23:20.000Z"},"results_count":{"type":"integer","description":"Number of valid organizations returned","example":1},"errors":{"type":"array","description":"List of errors encountered","items":{"type":"string"}},"data":{"type":"array","description":"Array of organizations checked for their eligibility status","items":{"type":"object","properties":{"organization_name":{"type":"string","description":"Organiation's Name","example":"Candid"},"ein":{"type":"string","description":"Employee identification number","example":"13-1837418"},"eligibility_status":{"type":"boolean","description":"Indicates if the organization is eligible to receive donations through the provider. True means the organization is eligible. False means the organization is ineligible.","example":true},"eligibility_status_message":{"type":"string","description":"States if the organization is eligible to receive donations through the provider. If the organization is ineligible, reason for ineligibility is given in addition to next course of action.","example":"Your organization is eligible."},"eligibility_checked_date":{"type":"string","description":"The date an organization's eligibility was last checked.","example":"2022-01-20T19:00:04Z"},"profile_level":{"type":"string","description":"Guidestar.org organization profile seal of transparency level","example":"Platinum"},"profile_year":{"type":"string","description":"GuideStar seal year","example":"2022"},"profile_link":{"type":"string","description":"Guidestar.org organization profile URL","example":"https://www.guidestar.org/profile/13-1837418"},"seal_last_modified":{"type":"string","description":"Date when Candid seal status was modified.","example":"2022-01-20T19:00:04Z"},"website_url":{"type":"string","description":"Organization's website URL.","example":"candid.org"},"subsection_code":{"type":"object","properties":{"subsection_code":{"type":"string","description":"Subsection Codes are the codes shown under section 501(c) of the Internal Revenue Code of 1986, which define the category under which an organization may be exempt.","example":"03"},"subsection_code_description":{"type":"string","description":"Description of organization subsection code.","example":"501(c)(3) Public Charity"}}}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized"}},"text/json":{"schema":{"$ref":"#/components/schemas/Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}},"text/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"No Results Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotAcceptable"}},"text/json":{"schema":{"$ref":"#/components/schemas/NotAcceptable"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequests"}},"text/json":{"schema":{"$ref":"#/components/schemas/TooManyRequests"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}},"text/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}}},"components":{"schemas":{"BadRequest":{"type":"object","properties":{"code":{"type":"string","description":"HTTP response status code.","example":400},"message":{"type":"string","example":"The request cannot be fulfilled due to bad syntax."}}},"Unauthorized":{"type":"object","properties":{"code":{"type":"string","description":"HTTP response status code.","example":401},"message":{"type":"string","example":"Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API."}}},"Forbidden":{"type":"object","properties":{"code":{"type":"string","description":"HTTP response status code.","example":403},"message":{"type":"string","example":"Forbidden, we found insufficient permissions to grant access to the resources. Please check the detailed message of the response."}}},"NotFound":{"type":"object","properties":{"code":{"type":"string","description":"HTTP response status code.","example":404},"message":{"type":"string","example":"Request was processed successfully but we could not find the resource ein"}}},"NotAcceptable":{"type":"object","properties":{"code":{"type":"string","description":"HTTP response status code.","example":406},"message":{"type":"string","example":"The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request."}}},"TooManyRequests":{"type":"object","properties":{"code":{"type":"string","description":"HTTP response status code.","example":429},"message":{"type":"string","example":"Rate limit is exceeded. Try again later."}}},"InternalServerError":{"type":"object","properties":{"code":{"type":"string","description":"HTTP response status code.","example":500},"message":{"type":"string","example":"Oh no!, this is bad, something went wrong... please contact API support!"}}}},"securitySchemes":{"apiKeyHeader":{"type":"apiKey","name":"Subscription-Key","in":"header"},"apiKeyQuery":{"type":"apiKey","name":"Subscription-Key","in":"query"}}},"security":[{"apiKeyHeader":[]},{"apiKeyQuery":[]}],"x-readme":{"explorer-enabled":true,"proxy-enabled":true}}