Spike Documentation

Spike makes your credit applications better, cheaper and faster

This site houses the documentation for the Spike product. The documentation serves two purposes:

1. to provide additional clarity on the Spike product offering
2. to provide technical resources for accessing our API

You will find a table of contents for this documentation in the side navigation to the left. Alternatively see or our website (opens new window) for an overview of our product.

Product resources

Our product resources cover:

• product guides
  • our product guides provide specifics on our commercial offering like credits, pricing, support, as well as explanations of features like authenticity
• statement library
  • The statement library lists all of the pdf formats which we support
• user guides
  • the user guides describe how to use our ready-made products like the online web converter and the monitored inbox which are built on top of the Spike API;
  • as well as guides on how to obtain statements
• custom software development
  • let us help you to develop your proprietary lending, accounting or budgeting software applications
  • see the guide for more
• legal
  • our privacy policy, terms and conditions and POPIA compliance can all be found in our legal documentation

API resources

We provide a suite of technical resources in order to help developers make use of the Spike API. Some of these resources are maintained on external sites (like github and postman):

• Quick start guide
  • The quick start for new developers provides the shortest path to getting up and running for new devs.
• Specifications
  • We provide specifications for all API endpoints using the two most widely adopted REST-ful API definition systems: openapi (opens new window) and postman (opens new window)
• Developer guides
  • The developer guides provide guided walkthroughs and overviews of important features and concepts
• Libraries
  • For those that want type safety and other embellishments we support a range of programming language specific libraries to access the Spike API. This is entirely optional.
• Samples
  • For those who like to learn by doing we provide full source code for a range of sample applications that make use of the Spike API.
  • These can all be found in our samples repo (opens new window) on github - see the README for a table of samples.
• Support
  • If you get stuck we're on hand to assist. See our support guide.
• Articles
  • We have a collection of articles which provide greater insight into design decisions or technical aspects of the Spike product

You need to be on one of our premium pricing (opens new window) plans in order to access the Spike API. Contact us if you are an open source developer and wish to use the Spike API in your app.