Skip to main content

​
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.
1

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.
2

Verify connectivity

Call GET /match-pro/{customerId}/check-connection-status to confirm the saved credentials are valid and reachable before running any checks.
3

Run a check

Call POST /verification/customers/{customerId}/businesses/{businessId}/match-pro for a specific business. The call returns a task acknowledgment — the result is retrieved separately.
4

Retrieve the result

Poll GET /verification/businesses/{businessId}/match-pro until the result is available. Results typically appear within 1–5 minutes.

​
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.
After configuring credentials in the dashboard, confirm the setup from the API with GET /match-pro/{customerId}/check-connection-status before running checks. A CONNECTED status means credentials are valid and active. NOT_CONNECTED, EXPIRED, or ERROR indicate the configuration is not ready.

​
Running checks and retrieving results

Run a check with POST /verification/customers/{customerId}/businesses/{businessId}/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, 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:
  • sandbox — test data only
  • mtf — pre-production testing
  • prod — live data
The environment cannot be changed through the API. To move between environments — for example from Sandbox to Production — contact the Worth team.