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",
    "zip": "<string>"
  },
  "registries": [
    "ofac"
  ],
  "match_type": "PARTIAL"
}
'
[
  {
    "search_id": "<string>",
    "registry": "<string>",
    "result": "match_found",
    "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",
      "match_type": "PARTIAL"
    },
    "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

​
x-api-key
string
header
required

Body

application/json
​
external_id
string<uuid>
required

UUID of the person being checked

​
context
object
required
​
registries
enum<string>[]
required

Array of registries to search

Available options:
ofac,
sam-exclusion,
oig-exclusion,
nsopw
​
match_type
enum<string>

Type of matching to use for the search. PARTIAL matching takes into account aliases and name variations, while EXACT matching requires precise name matches. If not specified, the default from partner configuration will be used.

Available options:
PARTIAL,
EXACT

Response

200 - application/json
​
search_id
string
required

Unique identifier for this search execution

​
registry
string
required

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

​
result
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. This array will be empty if no matches are found.

​
filteredResults
object[]
required

Results that match the search criteria before filtering out false positives. This array will be empty if no filtered results are found.

​
attestation
object
required
​
registryPrettyName
string

Human-readable name of the registry