FAQs & Glossary
FAQs
Q. What's the difference between the Fountain API and PAPI?
A. Fountain API is built for clients. PAPI (Partner API) is built for partners.
Q. Is Partner Status required for the integration?
A. Yes, it is highly recommended to share Partner Status because it allows users to view, manage, and update applicants in the Fountain system.
Q. Are Partner Details required for the integration?
A. No, but they are useful for partners who wish to share additional application information for users to view, manage, and update applicants in the Fountain system.
Q. What API protocol does the Fountain Partner API use?
A. Fountain's Partner APIs are REST APIs.
Q. Can I share a link for a file hosted on a partner website?
A. Yes, you can link to URLs using both Partner Status and Partner Details.
Q. In the Workflow Editor, why am I seeing "Error Loading Packages" in the Partner Stage Options dropdown?
A. Please check the Integrations page to ensure that the correct API Key and Account ID credentials have been entered to connect the integration. Then refresh the Workflow Editor.
Q. When testing my Partner Stage in the applicant workflow, why am I getting stuck?
A. Please check the Partner Status and Partner Details you are sending back to Fountain and make sure they align with the Partner Rules you have configured in the Fountain workflow. If your Partner Service does not or cannot complete while the applicant is on your stage, make sure to send back a temporary status to advance the applicant to the next stage.
Q. What are Partners Labels?
A. Partner Labels are a legacy implementation of what is now Partner Status. Partner API continues to support legacy Partner Labels in limited capacity. We are in the process of deprecating it.
Glossary of Terms
- Applicant: Person applying to a Customer created job Opening.
- Applicant Portal: Applicant facing frontend that is used when going through an Opening.
- Customer: A Customer of Fountain that will use your Partner Service and generally has an account on your service.
- Opening: A collection of Stages setup by the Customer to funnel and evaluate Applicants.
- Partner Detail: Additional details about an Applicant from a Partner
- Available on the Applicant Table or in an Applicant's Profile.
- Partner Portal: Partners frontend that Applicant uses during Partner portion of an Opening's Workflow.
- Partner Rules: Conditional rules configured in the Partner Stage to automate actions based on the values of Partner Status or Partner Details.
- Partner Service: The service your organization provides as part of the Fountain Partner Program.
- Partner Stage: The Stage of an Opening's Workflow that is the portal to the Partner Service.
- Partner Stage Options (Stage Option Types): Used by Partners to offer different packages or services in their Partner Stage.
- Partner Status: Status updates from a Partner while it is processing an applicant's information.
- Partner Label: Legacy version of Partner Status for an Applicant
- Fountain is in the process of deprecating Partner Labels. Using Partner Status is best practice.
- User: Person using the Fountain Platform, generally a Customer User.
- Workflow Editor: UI used by Customer to create, maintain, and update an Opening.