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": [
{
"name": "ofac",
"match_type": "EXACT"
}
]
}
'[
{
"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>"
}
]Create a registry check
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": [
{
"name": "ofac",
"match_type": "EXACT"
}
]
}
'[
{
"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>"
}
]Unique identifier for this search execution
Registry code that was queried (e.g., "oig-exclusion", "nsopw", "sam", "ofac")
Outcome of the search
match_found, no_match_found 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
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
Human-readable name of the registry