Skip to main content
POST
Match One

Authorizations

Authorization
string
header
required

Customer API key (dm_live_…)

Body

application/json
input_name
string
required
Required string length: 1 - 512
input_url
string | null
Maximum string length: 2048
input_postcode
string | null
Maximum string length: 32
address
string | null

Optional full address.

Maximum string length: 512
sic_code
string | null
Maximum string length: 16
start_trading_date
string | null
Maximum string length: 32
id
string | null
Maximum string length: 128

Response

Match result. Fields reasons, degraded, and error are only included when the API key belongs to a superuser. rigorous_match, route, and confidence are always returned.

Full match result. reasons, degraded, and error only for superuser API keys.

input_name
string
required

Company name echoed from the request.

id
string | null

Optional correlation id echoed from the request.

input_url
string | null

Website URL echoed from the request, if provided.

input_postcode
string | null

Postcode echoed from the request, if provided.

address
string | null

Full address echoed from the request, if provided.

sic_code
string | null

SIC code echoed from the request, if provided.

start_trading_date
string | null

Trading / incorporation date hint echoed from the request.

matched_company_number
string | null

Companies House registration number (CRN) when a match is found; null when unmatched.

matched_company_name
string | null

Registered company name for the matched CRN, when available.

matched_registered_postcode
string | null

Registered office postcode for the matched CRN, when available.

active
string | null

Active / inactive (or equivalent) status when known.

rigorous_match
boolean
default:false

True when the slow path cleared the scoring threshold for this candidate. Fast-path exact name matches are also treated as strong evidence for confidence.

route
string | null

How the match was resolved: "fast" (exact name), "slow" (full pipeline), or null when unmatched.

confidence
enum<string>
default:none

Coarse evidence band. high: fast-path exact name or slow-path with rigorous_match; medium: slow-path without rigorous confirmation; low: weaker path; none: no CRN (or row-level error). Degraded pipeline steps drop the band one notch.

Available options:
high,
medium,
low,
none
reasons
string[]

Short scoring reason codes (superuser API keys only).

degraded
string[]

Pipeline steps that were unavailable or weakened for this row (superuser API keys only), e.g. url_gap_fill.

error
string | null

Row-level error message when matching failed (superuser API keys only).

Last modified on September 9, 2026