API reference
People
One person, with every license the index has resolved to them.
A person is the same human across records. When someone holds more than one license (in two jurisdictions, or as both a technician and a veterinarian over time), those licenses share a person_id.
Get a person
GET /v2/people/{id}
curl https://api.zuse.live/v2/people/12821 -H "Authorization: Bearer $ZUSE_KEY"{
"data": {
"id": 12821,
"name": "JANE DOE",
"primary_state": "CA",
"license_count": 1,
"linked_by": "single",
"licenses": [
{
"id": 48211,
"person_id": 12821,
"name": "JANE DOE",
"profession": "veterinarian",
"credential": "DVM",
"jurisdiction": "CA",
"license_number": "16364",
"license_type": "Veterinarian",
"status": "active",
"is_active": true,
"issued_on": "2018-07-06",
"expires_on": "2027-08-31",
"years_licensed": 8,
"city": "LOS ANGELES",
"state": "CA",
"red_flags": [],
"verify_url": "https://search.dca.ca.gov/"
}
]
},
"billing": { "operation": "verify", "cost_usd": 0.02, "credit_remaining_usd": 9.98 }
}Each entry in licenses is a license object.
How licenses are joined into one person
Licenses carrying the same name, in the same profession, are joined when one of these holds. linked_by names the weakest rule that joined the person:
linked_by | Rule | How sure |
|---|---|---|
single | One license | |
same_number | Same state and the same license number (an intern who became a veterinarian under one number) | Certain |
npi | One record in the federal NPI register names both licenses by number, and the names fit (the boards may spell them differently) | Certain |
relicensed | Same state and license type, a new number issued after the old one ended, and the middle names agree | Strong |
location | The same street address and ZIP code on both records; at an address many people give (a hospital), the middle names must agree too | Strong |
full_name | The same full middle name in every state, one license per state, and nobody else in the index of that first and last name | Strong |
same_state, rare_name | Older joins, kept until the person is next re-resolved. Treat rare_name as multiple licenses on record that may belong together | Confirm before relying on it |
Two licenses whose middle names disagree, or whose suffixes differ (Jr, Sr), are never joined. Two licenses of the same type in one state that are both current are never joined: they are two people. A matching name alone, with nothing else agreeing, joins nobody.
When people are joined, the person keeps the lower id. The other id still works here: GET /v2/people/{id} answers with the person it was joined into.
List a person's licenses
GET /v2/people/{id}/licenses
The same licenses as a list, in the standard list envelope, for clients that treat every collection the same way.
Where person_id comes from
Every professional and every license carries a person_id. Pass it here to see everything on record for that person before you act on one license.
Billing
Billed at the License check price. An unknown id is a 404 and is free.