> ## Documentation Index
> Fetch the complete documentation index at: https://docs.worthai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Match Pro Overview

> Configure credentials, verify connectivity, and run Match Pro checks against businesses in your portfolio.

## What is Match Pro?

Match Pro lets you screen the businesses in your portfolio against a payment network's merchant termination database. Once configured, you can run checks per business and retrieve the results through the API.

All Match Pro requests require an `Authorization: Bearer <token>` header. The customer and business path parameters are scoped to your account — requests for resources outside your account are rejected with `403`.

## Recommended flow

<Steps>
  <Step title="Configure credentials">
    Set up your Match Pro credentials (consumer key, customer name, ICA identifiers, and key file) in the Worth dashboard. Credential setup is managed through the UI, not the API.
  </Step>

  <Step title="Verify connectivity">
    Call [`GET /match-pro/{customerId}/check-connection-status`](/api-reference/integration/match-pro/check-match-pro-connection) to confirm the saved credentials are valid and reachable before running any checks.
  </Step>

  <Step title="Run a check">
    Call [`POST /verification/customers/{customerId}/businesses/{businessId}/match-pro`](/api-reference/integration/match-pro/run-match-pro) for a specific business. The call returns a task acknowledgment — the result is retrieved separately.
  </Step>

  <Step title="Retrieve the result">
    Poll [`GET /verification/businesses/{businessId}/match-pro`](/api-reference/integration/match-pro/get-match-pro-result) until the result is available. Results typically appear within 1–5 minutes.
  </Step>
</Steps>

## Managing credentials

Match Pro credentials (consumer key, customer name, ICA identifiers, and key file) are configured in the Worth dashboard, not through the API. Set up or update your credentials in the UI before using the Match Pro endpoints.

<Note>
  After configuring credentials in the dashboard, confirm the setup from the API with [`GET /match-pro/{customerId}/check-connection-status`](/api-reference/integration/match-pro/check-match-pro-connection) before running checks. A `CONNECTED` status means credentials are valid and active. `NOT_CONNECTED`, `EXPIRED`, or `ERROR` indicate the configuration is not ready.
</Note>

## Running checks and retrieving results

Run a check with [`POST /verification/customers/{customerId}/businesses/{businessId}/match-pro`](/api-reference/integration/match-pro/run-match-pro). The request body is optional: include `{ "icas": ["1996"] }` to target specific ICA identifiers, or omit it to use the ICAs stored in your credentials.

Checks run asynchronously, so this endpoint returns a task acknowledgment rather than the result. Retrieve the result with [`GET /verification/businesses/{businessId}/match-pro`](/api-reference/integration/match-pro/get-match-pro-result), which returns one of three states: result available, still processing, or not yet run. Results typically appear within 1–5 minutes, so poll periodically until the result is available.

## Environment

You can check which Match Pro environment your account is configured for with [`GET /match-pro/{customerId}/environment`](/api-reference/integration/match-pro/get-match-pro-environment):

* `sandbox` — test data only
* `mtf` — pre-production testing
* `prod` — live data

<Note>
  The environment cannot be changed through the API. To move between environments — for example from Sandbox to Production — contact the Worth team.
</Note>