Skip to main content
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"
  }
}'
[
  {
    "search_id": "<string>",
    "registry": "<string>",
    "status": "match_found",
    "query": {
      "external_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "context": {
        "first_name": "<string>",
        "middle_name": "<string>",
        "last_name": "<string>",
        "date_of_birth": "2023-12-25"
      },
      "searched_at": "2023-11-07T05:31:56Z"
    },
    "metadata": {
      "last_updated_at": "2023-12-25"
    },
    "matches": [
      {
        "match_type": "individual",
        "name": {
          "first": "<string>",
          "middle": "<string>",
          "last": "<string>"
        },
        "identifiers": {
          "npi": "<string>",
          "dob": "2023-12-25"
        },
        "address": {
          "line1": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zip": "<string>"
        }
      }
    ]
  }
]

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
registry
enum<string>[]
required

One or more registry codes separated by commas

Body

application/json
​
external_id
string<uuid>
required

UUID of the person being checked

​
context
object
required

Response

200 - application/json

Array of registry search results; each object represents one registry that was queried for a single provider.

​
search_id
string
required

Unique identifier for this search execution

​
registry
string
required

Registry code that was queried (e.g., "oig-exclusions", "nso", "sam", "ofac")

​
status
enum<string>
required

Outcome of the search

Available options:
match_found,
no_match_found
​
query
object
required
​
metadata
object
required
​
matches
object[]
required

Potential records returned by the registry that resemble the query subject

⌘I