---
title: "Entity Name Matching"
method: POST
path: "/matching/match"
tags: ["Entity Matching"]
---

# Entity Name Matching

`POST /matching/match`

## Request

- Base URL: `https://api.creditbenchmark.com`
- URL: `https://api.creditbenchmark.com/matching/match`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/creditbenchmark/apis/credit-benchmark-api/docs/matching/match/post.ts> (a function with typed inputs; its response is checked against the schema)

Return ranked entity matches.

## Request body

- MatchBody: Request body for entity name matching
  - `queries` Query[], required: List of company names to match
    - `text` string, required: The company name to match
    - `industry` string: Optional industry filter to improve matching accuracy
    - `lei` string: Optional Legal Entity Identifier (LEI) for exact matching
    - `country_name` string: Optional country name or code to filter matches

## Response `200`

Entity matching completed successfully

- MatchExternalResponse: Response containing entity matching results
  - `results` ExternalMatchRow[], required: Table-style results keyed by input entity
    - `entity` string, required: Original query text
    - `candidates` ExternalCandidate[], required: Ordered list of candidate matches, sorted by rank
      - `rank` integer, required: 1-based rank of the candidate (1 = best match)
      - `CBId` string, required: Credit Benchmark entity identifier
      - `CBEntityName` string, required: Credit Benchmark entity name
      - `CBCountryOfRiskISO` string: ISO 3166-1 alpha-2 country code
      - `isConsensus1M` boolean: Whether the entity has a 1-month consensus rating
      - `confidence` number, float, required: Confidence score for the match (0.0 to 1.0)

## Other responses

- `400`: Bad request - invalid parameters
- `401`: Unauthorized - invalid or missing JWT token
- `403`: Forbidden - insufficient permissions or access denied
- `422`: Validation error - request parameters are invalid
- `500`: Internal server error

---

[API](https://skmtc.dev/creditbenchmark/apis/credit-benchmark-api.md) - [All operations](https://skmtc.dev/creditbenchmark/apis/credit-benchmark-api/llms.txt) - [OpenAPI document](https://skmtc.dev/creditbenchmark/apis/credit-benchmark-api/revisions/b357bbdb41e6?raw)