Skip to main content
GET
/
verification
/
businesses
/
{businessId}
/
match-pro
Get Match Pro Result
curl --request GET \
  --url https://api.joinworth.com/integration/api/v1/verification/businesses/{businessId}/match-pro \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "message": "Match Pro result retrieved successfully",
  "data": {
    "matchData": {
      "businessId": "b9c8d7e6-f5a4-3210-fedc-ba9876543210",
      "matchResult": "No Match"
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
businessId
string
required

UUID of the business whose Match Pro result to retrieve.

Example:

"b9c8d7e6-f5a4-3210-fedc-ba9876543210"

Response

Match Pro result retrieved. See response examples for the three possible states.

Response from the Match Pro result endpoint. The shape varies based on the current state of the check: result available, still processing, or not yet run.

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

Descriptive message about the current state.

​
data
object

Match result data, a processing indicator, or an error structure depending on state.