How API Integrations Work with SchemeServe

API integrations let SchemeServe connect with other systems so information can be shared automatically (instead of being copied and pasted).

SchemeServe supports two main types of API integrations:

1) Using SchemeServe’s Developer APIs (your system connects to SchemeServe)

SchemeServe provides Developer APIs (REST APIs) that allow your software to read data from SchemeServe and, in some cases, send data into SchemeServe.

Common uses:

• Pull accounting reports into your finance system
• Export data into a data warehouse or reporting tool (e.g., Power BI)
• Sync SchemeServe data with internal admin tools

How it works:

• Your system sends a request to SchemeServe’s API
• SchemeServe checks the security token (authentication)
• SchemeServe returns the data (usually in JSON format)

Example: Accounting Reports API

• SchemeServe includes endpoints for generating accounting reports via API, such as:
  Summary reports
  Detailed report breakdowns

This is useful if you want to automate reporting instead of downloading spreadsheets manually.

2) Using the API Builder (SchemeServe connects to other services)

SchemeServe also includes an API Builder, which lets you connect SchemeServe workflows to third-party APIs.

This means SchemeServe can send requests to other platforms while a user is completing a journey (for example, during onboarding, underwriting, or policy servicing).

Common uses_

You can use the API Builder to:

• Look up business details (e.g., Companies House)
• Run compliance checks (e.g., sanctions screening)
• Validate addresses (e.g., Google Maps)
• Send notifications (e.g., SMS or email providers)

How it works (simple view)

A workflow step in SchemeServe triggers an API call:
- API type question
- API call built into rating file

SchemeServe sends data to the third-party service

The third-party service returns a result:
- Results are stored in hidden question
- Hidden questions are used for further actions e.g. referrals, loads etc…

Which integration option should you use?

Use SchemeServe Developer APIs if:
✅ You want your own system to pull data from SchemeServe
✅ You want scheduled reporting or exports
✅ You are building your own integration externally

Use API Builder if:
✅ You want SchemeServe to connect to another API inside a workflow
✅ You want live lookups, validation, or automated checks
✅ You want to configure integrations with minimal custom development