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

# Run Match Pro

> Initiates a Match Pro check for a specific business. The check runs asynchronously; this endpoint returns a task acknowledgment, not the match result.

To retrieve the match result, poll `GET /verification/businesses/{businessId}/match-pro` after the task reaches `completed` status. Results typically appear within 1–5 minutes.

**Prerequisites**: Match Pro credentials must be configured in the Worth dashboard and the connection must be `CONNECTED` before running a check. Verify connectivity with `GET /match-pro/{customerId}/check-connection-status`.

The `customerId` and `businessId` path parameters must belong to the caller's tenant. Cross-tenant access is rejected with `403`.



## OpenAPI

````yaml openapi/integration-service/match-pro.json post /verification/customers/{customerId}/businesses/{businessId}/match-pro
openapi: 3.1.0
info:
  title: Integration Service
  description: >-
    Match Pro endpoints for running payment network match checks against
    businesses.
  version: '1.0'
servers:
  - url: https://api.joinworth.com/integration/api/v1
    variables: {}
security:
  - bearer: []
paths:
  /verification/customers/{customerId}/businesses/{businessId}/match-pro:
    post:
      tags:
        - Match Pro
      summary: Run Match Pro
      description: >-
        Initiates a Match Pro check for a specific business. The check runs
        asynchronously; this endpoint returns a task acknowledgment, not the
        match result.


        To retrieve the match result, poll `GET
        /verification/businesses/{businessId}/match-pro` after the task reaches
        `completed` status. Results typically appear within 1–5 minutes.


        **Prerequisites**: Match Pro credentials must be configured in the Worth
        dashboard and the connection must be `CONNECTED` before running a check.
        Verify connectivity with `GET
        /match-pro/{customerId}/check-connection-status`.


        The `customerId` and `businessId` path parameters must belong to the
        caller's tenant. Cross-tenant access is rejected with `403`.
      operationId: RunMatchPro
      parameters:
        - name: customerId
          in: path
          description: >-
            UUID of the customer tenant. Must belong to the authenticated
            caller's tenant.
          required: true
          schema:
            type: string
            examples:
              - a1b2c3d4-e5f6-7890-abcd-ef1234567890
        - name: businessId
          in: path
          description: UUID of the business to run the Match Pro check against.
          required: true
          schema:
            type: string
            examples:
              - b9c8d7e6-f5a4-3210-fedc-ba9876543210
      requestBody:
        required: false
        description: >-
          Optional body to specify ICA identifiers. If omitted, the check uses
          the ICA values stored in the customer's saved credentials.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RunMatchProRequest'
            examples:
              with_icas:
                summary: Specify ICA identifiers
                value:
                  icas:
                    - '1996'
                    - '2000'
              without_icas:
                summary: Use configured ICAs (omit body)
                value: {}
      responses:
        '200':
          description: >-
            Match Pro check initiated. Returns a task acknowledgment — not the
            match result. Retrieve the result via `GET
            /verification/businesses/{businessId}/match-pro`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MatchProTaskResponse'
              examples:
                completed:
                  summary: Task completed synchronously
                  value:
                    status: success
                    message: >-
                      Match-pro task created and processed with state of
                      completed
                    data:
                      task_status: completed
                      metadata:
                        businessId: b9c8d7e6-f5a4-3210-fedc-ba9876543210
                        customerId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                in_progress:
                  summary: Task still processing
                  value:
                    status: success
                    message: >-
                      Match-pro task created and processed with state of
                      in_progress
                    data:
                      task_status: in_progress
                      metadata:
                        businessId: b9c8d7e6-f5a4-3210-fedc-ba9876543210
                        customerId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        '400':
          description: >-
            Validation error — non-alphanumeric ICA values, duplicate ICA
            entries, or more than 100 ICAs provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid Bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: >-
            Cross-tenant access denied. The `customerId` or `businessId` does
            not belong to the caller's tenant.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearer: []
components:
  schemas:
    RunMatchProRequest:
      title: RunMatchProRequest
      type: object
      description: >-
        Optional request body for specifying ICA identifiers to use for this
        match check. If omitted (or an empty object is sent), the check uses the
        ICA values from the customer's saved Match Pro credentials.
      properties:
        icas:
          type: array
          items:
            type: string
            pattern: ^[a-zA-Z0-9]+$
            description: Alphanumeric ICA identifier.
          maxItems: 100
          uniqueItems: true
          description: >-
            Optional array of alphanumeric ICA identifiers (max 100). Each value
            must be alphanumeric; duplicates are rejected. Omitting this field
            falls back to the customer's configured ICAs.
          examples:
            - - '1996'
              - '2000'
    MatchProTaskResponse:
      title: MatchProTaskResponse
      type: object
      description: >-
        Task acknowledgment returned immediately when a Match Pro check is
        initiated. This is NOT the match result — retrieve the result via `GET
        /verification/businesses/{businessId}/match-pro`.
      properties:
        status:
          type: string
          enum:
            - success
        message:
          type: string
          examples:
            - Match-pro task created and processed with state of completed
        data:
          type: object
          properties:
            task_status:
              type: string
              enum:
                - completed
                - initialized
                - started
                - in_progress
                - failed
              description: Current state of the Match Pro task.
            metadata:
              type: object
              description: >-
                Task context. Contents vary by task; when present, may include
                the associated `businessId` and `customerId`.
              properties:
                businessId:
                  type: string
                  description: >-
                    UUID of the business the task was run against, when
                    available.
                customerId:
                  type: string
                  description: UUID of the customer tenant, when available.
              additionalProperties: true
    ErrorResponse:
      title: ErrorResponse
      type: object
      properties:
        status:
          type: string
          enum:
            - error
            - fail
        message:
          type: string
          description: Description of the error.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````