Skip to main content

Send a test notification

Once we have registered your webhook endpoints, you can trigger a test credit status notification directly. You do not need a live customer application to test this flow.

Test events can be sent to your live destination, or to sandbox if you have configured a sandbox endpoint.

FinMatch stores these endpoints on your profile. Do not pass a target URL in the payload.

Use POST https://api.finmatch.io/v1/notifications/test for both target environments.

An API key beginning with sk_test_… dispatches a test event to your registered sandbox webhook.

An API key beginning with sk_live_… dispatches a test event to your registered live webhook.

Before you send a test​

  1. Provide your live HTTPS webhook URL to partners@finmatch.io, alongside a sandbox URL if you plan to test in sandbox.
  2. Wait for confirmation from our team that your endpoints have been registered.
  3. Authenticate using the Partner API key corresponding to your target environment:
    • Live events: sk_live_…
    • Sandbox events: sk_test_…

This key serves as your Bearer token. Ensure you have a valid key for each target environment. You can request missing keys when registering your endpoints.

Endpoints must use public https:// addresses without basic auth credentials or query parameters.

Send the test​

POST https://api.finmatch.io/v1/notifications/test
Authorization: Bearer sk_test_… or sk_live_…
  • sk_test_… delivers to your saved sandbox destination.
  • sk_live_… delivers to your saved live destination.

Send an empty request body; our system populates the test payload automatically. Do not include API keys or endpoint URLs inside the request body or path.

To simulate a payload for a specific provider, include the lender query parameter with no request body:

POST https://api.finmatch.io/v1/notifications/test?lender=zopa
POST https://api.finmatch.io/v1/notifications/test?lender=propensio
  • zopa uses sample reference T3STREF1
  • propensio uses sample reference 1234567

If lender is omitted, a standard test payload is delivered. The secret key determines which configured endpoint receives the notification.

What you should see​

FinMatch posts a signed test event to your configured endpoint:

  • event_type is set to credit_application.test
  • FinMatch-Test header is set to true
  • Identifiers are placeholder values or null (T3STREF1 for Zopa, 1234567 for Propensio)

Validate the FinMatch-Signature header, return a 2xx HTTP response, and drop the payload. This event does not represent a live application and should not update production records.

If it fails​

ResponseMeaning
401Invalid or missing API key.
409No HTTPS webhook registered for the specified key environment.
429Rate limit exceeded (100 successful deliveries per environment per UTC month).

Requests resulting in 401, 409, or 429 statuses are excluded from rate limits. No burst interval restrictions apply.

Postman​

  1. Create a request → POST https://api.finmatch.io/v1/notifications/test (append ?lender=zopa or ?lender=propensio if needed)
  2. Configure Authorization → Bearer Token using sk_live_… for production or sk_test_… for sandbox
  3. Leave the body blank
  4. Execute the request
  5. Verify that your webhook endpoint received credit_application.test with a valid FinMatch-Signature header