🧬Endpoint and Schema Overview

The endpoints and schemas for Gathr are listed below. If you're looking for something more plug-and-play, click [here] to see more information on our white-label products.

Customers

Single Customer CRUD Functions

Create New Customer	Adding a new Customer
Find Customer	Retrieving a single Customer (using customerId)
Update Customer	Editing an existing Customer
Delete a Customer	Deleting an existing Customer
Get Customer by Custom Property	Retrieving a Customer (using a known property/identifier)
Get All Customers	Retrieve a list of all existing Customers for a specific tenant

Customers (Miscellaneous)

Endpoints	Function
Check Status of Customer	Check the application status of a Customer (in development)
Get Module Status of Customer	Get the specific Module Status of a Customer (in development)

Credit Report

Endpoints	Function
Get Customer Credit Report	Get the Credit Report of a single Customer
Get Credit Snapshot	Get a summarised Credit Report with key details
Get Credit Report and Score	Get the full Credit Report and Score of a Customer

Businesses

Endpoints	Function
Create for Customer	Create a business with a specific customer attached to it
Create without Customer	Create a business without a customer attached to it
Find Business	Find a business by businessId
Update Business	Update the details of an existing business
Delete a Business	Delete an existing business permanently
Get All Businesses	Retrieve a list of all existing Bustomers for a specific tenant

Identity

Endpoints	Function
Create new identity	Create a new identity record
Get single identity	Get a single identity record by identityDocumentId
Update single identity	Find a business by businessId
Delete single identity	Delete a single identity record
Upload ID document file	Upload an ID document
Return identity document validation	Validate the identity document against the details that the customer was created with

Affordability v1

Endpoints	Function
Create new iden	Create new Bank Account
Get single identity	Get a single identity record by identityDocumentId
Update single identity	Find a business by businessId
Delete single identity	Delete a single identity record
Upload ID document file	Upload an ID document
Return identity document validation	Validate the identity document against the details that the customer was created with