Skip to main content
POST
/
verification
/
customers
/
{customerId}
/
businesses
/
{businessId}
/
match-pro
curl --request POST \
  --url https://api.joinworth.com/integration/api/v1/verification/customers/{customerId}/businesses/{businessId}/match-pro \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "icas": [
    "1996",
    "2000"
  ]
}
'
{
  "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"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
customerId
string
required

UUID of the customer tenant. Must belong to the authenticated caller's tenant.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
businessId
string
required

UUID of the business to run the Match Pro check against.

Example:

"b9c8d7e6-f5a4-3210-fedc-ba9876543210"

Body

application/json

Optional body to specify ICA identifiers. If omitted, the check uses the ICA values stored in the customer's saved credentials.

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.

​
icas
string[]

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.

Maximum array length: 100

Alphanumeric ICA identifier.

Pattern: ^[a-zA-Z0-9]+$
Example:
["1996", "2000"]

Response

Match Pro check initiated. Returns a task acknowledgment — not the match result. Retrieve the result via GET /verification/businesses/{businessId}/match-pro.

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.

​
status
enum<string>
Available options:
success
​
message
string
Example:

"Match-pro task created and processed with state of completed"

​
data
object