Get Match Pro Result
curl --request GET \
--url https://api.joinworth.com/integration/api/v1/verification/businesses/{businessId}/match-pro \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.joinworth.com/integration/api/v1/verification/businesses/{businessId}/match-pro"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.joinworth.com/integration/api/v1/verification/businesses/{businessId}/match-pro', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.joinworth.com/integration/api/v1/verification/businesses/{businessId}/match-pro",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.joinworth.com/integration/api/v1/verification/businesses/{businessId}/match-pro"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.joinworth.com/integration/api/v1/verification/businesses/{businessId}/match-pro")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.joinworth.com/integration/api/v1/verification/businesses/{businessId}/match-pro")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "Match Pro result retrieved successfully",
"data": {
"matchData": {
"businessId": "b9c8d7e6-f5a4-3210-fedc-ba9876543210",
"matchResult": "No Match"
}
}
}Match Pro
Get Match Pro Result
Retrieves the latest Match Pro result for a business. The response shape depends on the current state:
- Result available: Returns the full match data object.
- Processing: The check is still running. Retry after a short delay (results typically appear within 1–5 minutes).
- Not yet run: No Match Pro check has been initiated for this business.
The businessId path parameter must belong to the caller’s tenant. Cross-tenant access is rejected with 403.
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>'import requests
url = "https://api.joinworth.com/integration/api/v1/verification/businesses/{businessId}/match-pro"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.joinworth.com/integration/api/v1/verification/businesses/{businessId}/match-pro', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.joinworth.com/integration/api/v1/verification/businesses/{businessId}/match-pro",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.joinworth.com/integration/api/v1/verification/businesses/{businessId}/match-pro"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.joinworth.com/integration/api/v1/verification/businesses/{businessId}/match-pro")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.joinworth.com/integration/api/v1/verification/businesses/{businessId}/match-pro")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "Match Pro result retrieved successfully",
"data": {
"matchData": {
"businessId": "b9c8d7e6-f5a4-3210-fedc-ba9876543210",
"matchResult": "No Match"
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
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.
Was this page helpful?