Comment on page
Gathr's API road map and resource kit
Gathr is a digital solution that helps you onboard and score customers seamlessly at scale with a great customer experience and rich data.
Gathr was built out of the frustration of constantly submitting documents to a call centre or filling in clunky PDF documents over email for any KYC or FICA verification process. Since its inception, we have found the utility of Gathr is boundless. Gathr is being used by mobile operators, banks, lenders, insurers, employers, auditors, and real estate agencies.
Before we jump in, there is a bit of terminology to get familiar with. This will help you contextualise the solution.
A Customer is an applicant for a product. You know, the person we mentioned above sending verification docs over email. Any application data is attached to a customer. As such, the first step to using Gathr is to set up a customer.
Customers are identified by the following unique field:
Businesses are their own entity and can act just like a customer, but can also have a customer linked to them.
Think about it like this. Either, the Business is applying for the product, or, the Customer (Director or CEO) is applying for the product on the business's behalf.
Businesses are identified by the following unique field:
Products are set up in the Gathr Dashboard. You will be issued a URL to log in to your Dashboard when setting up your profile. In the Dashboard, you will be able to lace together a sequence of Modules together to build a complete onboarding solution.
Applications are what track a Customer as they apply for a Product. The status of a Customer's Application is governed by the Modules which are attached to it.
You do not have to use Applications to track your clients. It is a cool tool to use to make sure you are getting your clients through the onboarding funnel and re-engaging them where they drop off instead of from the start.
You can always check the status of an Application by using the
Update Application Progressendpoint.
Each Product can have a combination of any of the below Modules. The intention is that you piece the Modules together to form the full onboarding solution for your Customer.
The Modules are:
- Consents [In Development]
- Personal Details
- Contract [In Development]
We will go through each of these modules in more detail in each of their respective sections.
Gathr has two main versions:
- 1.Staging copy, called UAT, and,
- 2.the official version called Production.
Staging runs the future updates that will be pushed to Production. Finch Technologies makes use of a testing and release cycle.
Finch Engineering Testing and Release Cycle
There are some minor restrictions in the Staging environment to take note of. Such as the number of requests that can be made and a few limitations on the data outputs. We do not want client using the Staging environment as though it was the production environment.
UAT Release Cycle
- Release Cycle 1
- UAT Deployment Friday 14:00
- Release Cycle 2
- UAT Deployment Tuesday 17:00
When you are ready to transition into production, we will issue you with production credentials.
Production Release Cycle
- Release Cycle 1
- Production Deployment Monday 15:00
- Release Cycle
- Production Deployment Wednesday 15:00
We know that the backbone of any enterprise solution is the support a team can provide. We have a technical support team and a business support team. Both teams should be able to help with standard requests and are available during working hours for all types of support queries.
We have created a Status Page which gives you insights into the uptime of our various services. You can view the statuses of all of our services within the respective Modules you are making use of (including those which rely on third parties such as the banks and bureaus). These statuses indicate whether the relevant endpoints are online or offline, so that you have peace of mind in knowing if the service is working as expected or not.
- Production incidents/outages
- Third party outages/disruption to services
- Scheduled maintenance
- Announcements relating to the sunsetting of older endpoints/services (or discontinued support thereof)
Some people function better when they learn by breaking things. Fortunately, you will not break Gathr. You will most likely just receive a few error codes. If you are ready to snap, crackle, and pop, just navigate to the below:
Dive a little deeper and start exploring our API reference to get an idea of everything that's possible with the API: