Quick Start
Get up and running with the RateMatch API in 5 minutes. This guide walks you through creating your first loan application.
Prerequisites
- API key from partner dashboard
- cURL or API client (Postman, Insomnia)
Step 1: Get Access Token
Exchange your API key for JWT tokens.
curl -X POST https://api.ratematch.com.au/v1/auth/token \
-H "Content-Type: application/json" \
-H "X-API-Key: rm_sandbox_your_key" \
-d '{"grantType": "api_key"}'Save the accessToken from the response.
Step 2: Create Application
Submit a new loan application with borrower details.
curl -X POST https://api.ratematch.com.au/v1/applications \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"formType": "personal",
"loanAmount": 15000,
"loanPurpose": "debt_consolidation",
"firstName": "John",
"lastName": "Smith",
"email": "john@example.com",
"phone": "0400000000"
}'Note the applicationId and securityToken from the response.
Step 3: Run Credit Check
Perform a credit check on the application.
curl -X POST https://api.ratematch.com.au/v1/applications/{applicationId}/credit-check \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-H "X-Sandbox-Score: 720" \
-d '{
"securityToken": "YOUR_SECURITY_TOKEN"
}'Tip: Use
X-Sandbox-Score header to simulate different credit scores in sandbox mode.Step 4: Get Matched Offers
Match the application against available lenders.
curl -X POST https://api.ratematch.com.au/v1/applications/{applicationId}/match \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"securityToken": "YOUR_SECURITY_TOKEN"
}'The response contains matched lender offers with rates and terms.