> ## Documentation Index > Fetch the complete documentation index at: https://docs.thedatacity.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Batch Results ## OpenAPI ````yaml https://datamatcher-api.thedatacity.com/api/v1/openapi.json get /api/v1/match/batch/{job_id}/results openapi: 3.1.0 info: title: DataMatcher API version: 1.2.0 servers: - url: https://datamatcher-api.thedatacity.com description: Production security: [] paths: /api/v1/match/batch/{job_id}/results: get: tags: - match summary: Get Batch Results operationId: match-get_batch_results parameters: - name: job_id in: path required: true schema: type: string format: uuid title: Job Id - name: skip in: query required: false schema: type: integer minimum: 0 default: 0 title: Skip - name: limit in: query required: false schema: type: integer maximum: 1000 minimum: 1 default: 100 title: Limit responses: '200': description: >- Batch results. Each row uses the same field visibility as POST /match: reasons, degraded, and error only for superuser API keys. content: application/json: schema: $ref: '#/components/schemas/BatchResultsPublic' '401': description: Missing or invalid API key '404': description: Job not found, or not owned by this API key's user '409': description: Results are not available until the job starts '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKey: [] components: schemas: BatchResultsPublic: properties: job_id: type: string format: uuid title: Job Id status: $ref: '#/components/schemas/JobStatus' total: type: integer title: Total skip: type: integer title: Skip limit: type: integer title: Limit data: items: $ref: '#/components/schemas/MatchResult' type: array title: Data type: object required: - job_id - status - total - skip - limit - data title: BatchResultsPublic HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError JobStatus: type: string enum: - queued - running - completed - failed - cancelled title: JobStatus MatchResult: properties: id: anyOf: - type: string - type: 'null' title: Id description: Optional correlation id echoed from the request. input_name: type: string title: Input Name description: Company name echoed from the request. input_url: anyOf: - type: string - type: 'null' title: Input Url description: Website URL echoed from the request, if provided. input_postcode: anyOf: - type: string - type: 'null' title: Input Postcode description: Postcode echoed from the request, if provided. address: anyOf: - type: string - type: 'null' title: Address description: Full address echoed from the request, if provided. sic_code: anyOf: - type: string - type: 'null' title: Sic Code description: SIC code echoed from the request, if provided. start_trading_date: anyOf: - type: string - type: 'null' title: Start Trading Date description: Trading / incorporation date hint echoed from the request. matched_company_number: anyOf: - type: string - type: 'null' title: Matched Company Number description: >- Companies House registration number (CRN) when a match is found; null when unmatched. matched_company_name: anyOf: - type: string - type: 'null' title: Matched Company Name description: Registered company name for the matched CRN, when available. matched_registered_postcode: anyOf: - type: string - type: 'null' title: Matched Registered Postcode description: Registered office postcode for the matched CRN, when available. company_status: anyOf: - type: string - type: 'null' title: Company Status description: >- Companies House status of the matched company, as the register reports it: "Active", an "Active - but in an unusual state (...)" variant (dormant accounts, proposal to strike off, liquidation, administration, ...), or "Struck off (Dissolved)". Null when unmatched or not known. active: anyOf: - type: string - type: 'null' title: Active description: >- Deprecated: use company_status. "True" when the matched company is not dissolved, "False" when it is; null when unmatched or not known. Kept for compatibility and removed in the next API version. rigorous_match: type: boolean title: Rigorous Match description: >- 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. default: false route: anyOf: - type: string - type: 'null' title: Route description: >- How the match was resolved: "fast" (exact name), "slow" (full pipeline), or null when unmatched. confidence: $ref: '#/components/schemas/MatchConfidence' description: >- 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. default: none reasons: items: type: string type: array title: Reasons description: Short scoring reason codes (superuser API keys only). degraded: items: type: string type: array title: Degraded description: >- Pipeline steps that were unavailable or weakened for this row (superuser API keys only), e.g. url_gap_fill. error: anyOf: - type: string - type: 'null' title: Error description: >- Row-level error message when matching failed (superuser API keys only). type: object required: - input_name title: MatchResult description: >- Full match result. reasons, degraded, and error only for superuser API keys. ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError MatchConfidence: type: string enum: - high - medium - low - none title: MatchConfidence description: Coarse evidence strength for a match. securitySchemes: APIKey: type: http description: Customer API key (`dm_live_…`) scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.