Find referrals by client identifiers
curl --request POST \
--url https://api.casexchange.com/api/public/v1/referrals/match \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"identifiers": {
"firstName": "<string>",
"lastName": "<string>",
"dateOfBirth": "2023-12-25",
"email": "jsmith@example.com",
"phone": "<string>"
}
}
'import requests
url = "https://api.casexchange.com/api/public/v1/referrals/match"
payload = { "identifiers": {
"firstName": "<string>",
"lastName": "<string>",
"dateOfBirth": "2023-12-25",
"email": "jsmith@example.com",
"phone": "<string>"
} }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
identifiers: {
firstName: '<string>',
lastName: '<string>',
dateOfBirth: '2023-12-25',
email: 'jsmith@example.com',
phone: '<string>'
}
})
};
fetch('https://api.casexchange.com/api/public/v1/referrals/match', 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.casexchange.com/api/public/v1/referrals/match",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'identifiers' => [
'firstName' => '<string>',
'lastName' => '<string>',
'dateOfBirth' => '2023-12-25',
'email' => 'jsmith@example.com',
'phone' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.casexchange.com/api/public/v1/referrals/match"
payload := strings.NewReader("{\n \"identifiers\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.casexchange.com/api/public/v1/referrals/match")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"identifiers\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.casexchange.com/api/public/v1/referrals/match")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"identifiers\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"candidates": [
{
"referralId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"referenceNumber": "<string>",
"matchScore": 0.5,
"matchedFields": [
"firstName"
],
"clientName": "<string>",
"currentStatus": "draft"
}
],
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}Referrals
Find referrals by client identifiers
Searches the caller’s firm’s referrals for clients matching the supplied identifiers and returns ranked candidates with a confidence score and the fields that matched. At least one identifier is required. Requires STANDARD tier (POST requests are rate-classified as writes even though this is a search). Note: the response body is { candidates, meta } — the candidate array is not nested under data.
POST
/
referrals
/
match
Find referrals by client identifiers
curl --request POST \
--url https://api.casexchange.com/api/public/v1/referrals/match \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"identifiers": {
"firstName": "<string>",
"lastName": "<string>",
"dateOfBirth": "2023-12-25",
"email": "jsmith@example.com",
"phone": "<string>"
}
}
'import requests
url = "https://api.casexchange.com/api/public/v1/referrals/match"
payload = { "identifiers": {
"firstName": "<string>",
"lastName": "<string>",
"dateOfBirth": "2023-12-25",
"email": "jsmith@example.com",
"phone": "<string>"
} }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
identifiers: {
firstName: '<string>',
lastName: '<string>',
dateOfBirth: '2023-12-25',
email: 'jsmith@example.com',
phone: '<string>'
}
})
};
fetch('https://api.casexchange.com/api/public/v1/referrals/match', 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.casexchange.com/api/public/v1/referrals/match",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'identifiers' => [
'firstName' => '<string>',
'lastName' => '<string>',
'dateOfBirth' => '2023-12-25',
'email' => 'jsmith@example.com',
'phone' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.casexchange.com/api/public/v1/referrals/match"
payload := strings.NewReader("{\n \"identifiers\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.casexchange.com/api/public/v1/referrals/match")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"identifiers\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.casexchange.com/api/public/v1/referrals/match")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"identifiers\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"candidates": [
{
"referralId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"referenceNumber": "<string>",
"matchScore": 0.5,
"matchedFields": [
"firstName"
],
"clientName": "<string>",
"currentStatus": "draft"
}
],
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}Authorizations
Public API key: cxp_<hex> (firm-scoped) or cxpp_<hex> (provider-scoped). Required on every request.
Body
application/json
At least one identifier must be provided
Show child attributes
Show child attributes

