For Developers

Integrate once, scale across products and markets

RESTful API with consistent authentication, comprehensive docs, and sandbox environment. Start building comparison experiences in minutes.

Quick start

Three steps to your first API call

1

Get API credentials

Request sandbox access and receive your API key and client ID for testing.

2

Authenticate

Use OAuth 2.0 client credentials flow to obtain an access token for API requests.

3

Make your first request

Call the /match endpoint with user context to receive personalised product matches.

Authentication

OAuth 2.0 client credentials flow

Client credentials

Receive a client ID and client secret when you register your integration. Store these securely—never expose them in client-side code.

CLIENT_ID=rm_abc123
CLIENT_SECRET=sk_live_xyz789

Access token

Exchange credentials for a short-lived access token. Include this token in the Authorization header of all API requests.

POST /oauth/token
{
  "grant_type": "client_credentials",
  "client_id": "rm_abc123",
  "client_secret": "sk_live_xyz789"
}

API requests

Include the access token in the Authorization header as a Bearer token.

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Key endpoints

Core API resources for building comparison experiences

POST/v1/match

Submit user context and receive matched product offers

Bearer token required

GET/v1/products

Retrieve available products and eligibility criteria

Bearer token required

POST/v1/applications

Submit application intent and track lifecycle

Bearer token required

POST/v1/webhooks

Configure webhook endpoints for async notifications

Bearer token required

SDKs & libraries

Official client libraries for popular languages

Node.js

Available

Python

Available

Ruby

Coming soon

Go

Coming soon

Sandbox environment

Test your integration with sample data before going live. Sandbox API behaves identically to production, with synthetic product data and mock provider responses.

Developer support

Documentation

Comprehensive guides, API reference, and code examples

API Status

Real-time system status and incident history

Developer Slack

Join our developer community for technical support

Ready to start building?

Get sandbox credentials and start integrating today