cURL
curl --request POST \
--url https://api.readyhealth.com/registry-check \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"external_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"context": {
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"date_of_birth": "2023-12-25",
"zip": "<string>"
},
"registries": [
{}
]
}
'import requests
url = "https://api.readyhealth.com/registry-check"
payload = {
"external_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"context": {
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"date_of_birth": "2023-12-25",
"zip": "<string>"
},
"registries": [{}]
}
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({
external_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
context: {
first_name: '<string>',
middle_name: '<string>',
last_name: '<string>',
date_of_birth: '2023-12-25',
zip: '<string>'
},
registries: [{}]
})
};
fetch('https://api.readyhealth.com/registry-check', 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.readyhealth.com/registry-check",
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([
'external_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'context' => [
'first_name' => '<string>',
'middle_name' => '<string>',
'last_name' => '<string>',
'date_of_birth' => '2023-12-25',
'zip' => '<string>'
],
'registries' => [
[
]
]
]),
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.readyhealth.com/registry-check"
payload := strings.NewReader("{\n \"external_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"context\": {\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"date_of_birth\": \"2023-12-25\",\n \"zip\": \"<string>\"\n },\n \"registries\": [\n {}\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.readyhealth.com/registry-check")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"external_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"context\": {\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"date_of_birth\": \"2023-12-25\",\n \"zip\": \"<string>\"\n },\n \"registries\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.readyhealth.com/registry-check")
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 \"external_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"context\": {\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"date_of_birth\": \"2023-12-25\",\n \"zip\": \"<string>\"\n },\n \"registries\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"search_id": "<string>",
"registry": "<string>",
"query": {
"external_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"registries": [
"<string>"
],
"context": {
"first_name": "<string>",
"last_name": "<string>",
"middle_name": "<string>",
"date_of_birth": "2023-12-25",
"zip": "<string>"
},
"searched_at": "2023-11-07T05:31:56Z"
},
"metadata": {
"last_updated_at": "2023-11-07T05:31:56Z"
},
"matches": [
{
"name": {
"first": "<string>",
"last": "<string>",
"middle": "<string>"
},
"identifiers": {
"npi": "<string>",
"dob": "2023-12-25"
},
"address": {
"line1": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>"
},
"aliases": [
"<string>"
]
}
],
"filteredResults": [
{
"name": {
"first": "<string>",
"last": "<string>",
"middle": "<string>"
},
"identifiers": {
"npi": "<string>",
"dob": "2023-12-25"
},
"address": {
"line1": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>"
},
"aliases": [
"<string>"
]
}
],
"attestation": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"type": "EXTERNAL_VALIDATION",
"metadata": {
"input": {
"result": "<string>",
"client_name": "<string>",
"issuer_name": "<string>",
"search_date": "<string>",
"candidate_dob": "<string>",
"registry_type": "<string>",
"certificate_type": "<string>",
"filtered_results": [
{
"last_name": "<string>",
"first_name": "<string>",
"middle_name": "<string>",
"date_of_birth": "2023-12-25"
}
],
"candidate_full_name": "<string>"
},
"bucket": "<string>",
"template": "<string>"
},
"documentId": "<string>",
"registrySearchId": "<string>",
"fileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deletedAt": "<string>",
"file": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "<string>",
"childIndex": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"deletedAt": "<string>",
"originalName": "<string>",
"mimeType": "<string>",
"parentId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"url": "<string>",
"quality": "<string>"
}
},
"registryPrettyName": "<string>"
}
]Searches
Create a Search
Create a registry check
POST
/
registry-check
cURL
curl --request POST \
--url https://api.readyhealth.com/registry-check \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"external_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"context": {
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"date_of_birth": "2023-12-25",
"zip": "<string>"
},
"registries": [
{}
]
}
'import requests
url = "https://api.readyhealth.com/registry-check"
payload = {
"external_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"context": {
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"date_of_birth": "2023-12-25",
"zip": "<string>"
},
"registries": [{}]
}
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({
external_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
context: {
first_name: '<string>',
middle_name: '<string>',
last_name: '<string>',
date_of_birth: '2023-12-25',
zip: '<string>'
},
registries: [{}]
})
};
fetch('https://api.readyhealth.com/registry-check', 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.readyhealth.com/registry-check",
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([
'external_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'context' => [
'first_name' => '<string>',
'middle_name' => '<string>',
'last_name' => '<string>',
'date_of_birth' => '2023-12-25',
'zip' => '<string>'
],
'registries' => [
[
]
]
]),
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.readyhealth.com/registry-check"
payload := strings.NewReader("{\n \"external_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"context\": {\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"date_of_birth\": \"2023-12-25\",\n \"zip\": \"<string>\"\n },\n \"registries\": [\n {}\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.readyhealth.com/registry-check")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"external_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"context\": {\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"date_of_birth\": \"2023-12-25\",\n \"zip\": \"<string>\"\n },\n \"registries\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.readyhealth.com/registry-check")
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 \"external_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"context\": {\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"date_of_birth\": \"2023-12-25\",\n \"zip\": \"<string>\"\n },\n \"registries\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"search_id": "<string>",
"registry": "<string>",
"query": {
"external_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"registries": [
"<string>"
],
"context": {
"first_name": "<string>",
"last_name": "<string>",
"middle_name": "<string>",
"date_of_birth": "2023-12-25",
"zip": "<string>"
},
"searched_at": "2023-11-07T05:31:56Z"
},
"metadata": {
"last_updated_at": "2023-11-07T05:31:56Z"
},
"matches": [
{
"name": {
"first": "<string>",
"last": "<string>",
"middle": "<string>"
},
"identifiers": {
"npi": "<string>",
"dob": "2023-12-25"
},
"address": {
"line1": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>"
},
"aliases": [
"<string>"
]
}
],
"filteredResults": [
{
"name": {
"first": "<string>",
"last": "<string>",
"middle": "<string>"
},
"identifiers": {
"npi": "<string>",
"dob": "2023-12-25"
},
"address": {
"line1": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>"
},
"aliases": [
"<string>"
]
}
],
"attestation": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"type": "EXTERNAL_VALIDATION",
"metadata": {
"input": {
"result": "<string>",
"client_name": "<string>",
"issuer_name": "<string>",
"search_date": "<string>",
"candidate_dob": "<string>",
"registry_type": "<string>",
"certificate_type": "<string>",
"filtered_results": [
{
"last_name": "<string>",
"first_name": "<string>",
"middle_name": "<string>",
"date_of_birth": "2023-12-25"
}
],
"candidate_full_name": "<string>"
},
"bucket": "<string>",
"template": "<string>"
},
"documentId": "<string>",
"registrySearchId": "<string>",
"fileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deletedAt": "<string>",
"file": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "<string>",
"childIndex": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"deletedAt": "<string>",
"originalName": "<string>",
"mimeType": "<string>",
"parentId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"url": "<string>",
"quality": "<string>"
}
},
"registryPrettyName": "<string>"
}
]Authorizations
Body
application/json
Response
200 - application/json
Unique identifier for this search execution
Registry code that was queried (e.g., "oig-exclusion", "nsopw", "sam", "ofac")
Outcome of the search
Available options:
match_found, no_match_found Show child attributes
Show child attributes
Show child attributes
Show child attributes
Potential records returned by the registry that resemble the query subject. This array will be empty if no matches are found.
Show child attributes
Show child attributes
Results that match the search criteria before filtering out false positives. This array will be empty if no filtered results are found.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Human-readable name of the registry
⌘I