MIRA

Build on MIRA

Start a customer's journey from your own dealer management or broker system. MIRA takes it from there: it guides the customer through each step in the MIRA app, with a one-tap link in every email, runs the identity check and the verified handover, and reports every step back to your system with signed webhooks.

Three journeys

Finance, identity check and handover

FINANCE_IDENTITY_DELIVERY

The full flow for a financed sale: the finance application, then the customer's identity check, then the verified handover.

  1. 1You send the deal. Either it is already on your own finance panel (ALREADY_SUBMITTED, with your panel reference), or you send the full application and MIRA submits it to your configured panel (SUBMIT_VIA_MIRA).
  2. 2The customer gets a sign-in link and verifies their identity in the app.
  3. 3The lender decision comes from you (ALREADY_SUBMITTED) or from the panel (SUBMIT_VIA_MIRA).
  4. 4Once finance is approved and the customer is verified, the handover is created and the customer completes it in the app.

Dealer or broker keys

Identity check and handover

IDENTITY_DELIVERY

For a financed sale already approved on your own panel. You send who to verify; MIRA runs the identity check, tells you the result, then runs the handover.

  1. 1You send the customer, vehicle and handover details, and optionally your panel name, reference and lender. No finance application is needed: it is recorded as approved.
  2. 2The customer gets a sign-in link and verifies their identity in the app.
  3. 3As soon as they are verified, the handover is created and the customer completes it in the app.

Dealer or broker keys

Handover only

DELIVERY

A verified handover with no finance application in MIRA. Say whether it is a cash sale or a finance sale.

  1. 1CASH_SALE: the customer verifies their identity and, for a home delivery, confirms their address in the app, then completes the handover.
  2. 2FINANCE_SALE: the finance and identity checks happened outside MIRA, so you send a photo of the customer with their consent, used to verify the handover.
  3. 3A match completes the handover; anything unclear goes to your team to review.

Dealer or broker keys (cash sales: dealer keys)

What MIRA does for you

Your customer, guided

Send the customer's name and email. MIRA sends them everything they need in your company's name, with each step one tap away in the MIRA app.

Signed webhooks

One endpoint for live events and one for test events, each signed with HMAC-SHA256, retried for about two days, with a delivery log you can resend from.

A real sandbox

Test keys run the same journeys with simulated outcomes: no real customer, handover, charge or customer email. You can force any outcome.

Your finance panel, or ours

Tell MIRA about a deal already on your own panel, or send the full application and MIRA submits it to the panel you have set up.

Quick start

  1. In MIRA Business, open Settings, API Keys, switch to Test and generate a test key (it starts with ms_test_).
  2. Optionally add a test endpoint under Settings, Webhooks.
  3. Start a journey:
curl
curl -X POST https://api.motorsync.co.uk/api/v1/journeys \
  -H "Authorization: Bearer ms_test_..." \
  -H "Idempotency-Key: deal-88213" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "IDENTITY_DELIVERY",
    "externalReference": "DMS-88213",
    "customer": {
      "firstName": "Jane", "lastName": "Doe",
      "email": "jane@example.com", "mobile": "07700900000"
    },
    "vehicle": { "registration": "AB21XYZ", "make": "BMW", "model": "3 Series", "year": 2021 },
    "delivery": { "type": "HOME_DELIVERY" },
    "finance": { "panelName": "iVendi", "panelReference": "IV-123456", "lender": "Close Brothers" }
  }'

Every request goes to https://api.motorsync.co.uk/api/v1/journeys with your key as a bearer token. When your integration works, generate a live key (ms_live_) and a live endpoint, and change nothing else.

Read the docs