{"openapi":"3.1.0","info":{"title":"Allied Verify API","version":"v1","description":"Search and verify allied-health licenses and credentials (physical therapy, occupational therapy, respiratory care, speech-language pathology, audiology and athletic training) from official state sources.\n\nAuthenticate with an API key: `Authorization: Bearer avk_...`. Create keys on your account page. Each verification uses one credit, including every license-number check. Name search, coverage and source metadata are free.\n\nThis API reports what official sources publish at a point in time. It does not monitor credentials continuously."},"servers":[{"url":"/"}],"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"An API key that starts with `avk_`."}},"schemas":{"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["type","message"],"properties":{"type":{"type":"string","description":"Machine-readable error type.","enum":["invalid_request","authentication_required","insufficient_credits","not_found","ambiguous_match","unsupported_jurisdiction","rate_limited"]},"message":{"type":"string","description":"Human-readable explanation."},"param":{"type":"string","description":"The request field that caused the error, when there is one."},"candidates":{"type":"array","items":{"$ref":"#/components/schemas/CredentialSummary"},"description":"Up to ten masked candidates on `ambiguous_match`."},"disambiguation_fields":{"type":"array","items":{"type":"string","enum":["city","county","credential_type","npi","credential_id"]},"description":"Fields that can identify at least one displayed candidate. Use the subject’s independently known NPI when applicable. Each listed credential ID selects that credential directly."},"state_request_url":{"type":"string","description":"Browser path to the state request form, filled in for `unsupported_jurisdiction`.","format":"uri-reference"}}}},"example":{"error":{"type":"insufficient_credits","message":"No verification credits remain. Buy a plan or top up."}}},"CredentialSummary":{"type":"object","description":"Search result. Search is free and returns identity fields only, with the license number masked (for example `PT•••02`). The full license number, status, dates, discipline and provenance come from a verification.","required":["object","id","jurisdiction","credential_type","credential_class","license_number","holder","location"],"properties":{"object":{"const":"credential"},"id":{"type":"string","description":"Credential id. Pass to `POST /v1/verifications` as `credential_id`."},"jurisdiction":{"type":"object","description":"Issuing state or district.","required":["code","name"],"properties":{"code":{"type":"string","description":"Stable machine code."},"name":{"type":"string","description":"Human-readable label."}}},"credential_type":{"type":"object","description":"Normalized credential type.","required":["code","name"],"properties":{"code":{"type":"string","description":"Stable machine code.","enum":["pt","pta","ot","ota","rt","slp","slpa","aud","auda","at","mrt","nct","ra","pmrt","mp","perf","sa","rd","dt","dp","hid","po","poa"]},"name":{"type":"string","description":"Human-readable label."}}},"credential_class":{"type":"object","description":"License, permit, compact privilege, certification or registration.","required":["code","name"],"properties":{"code":{"type":"string","description":"Stable machine code.","enum":["license","temporary_permit","limited_permit","compact_privilege","certification","registration","telehealth_registration"]},"name":{"type":"string","description":"Human-readable label."}}},"license_number":{"type":"string","description":"Masked license number. The last two digits can appear on longer numbers. A verification returns the full number."},"holder":{"type":"object","properties":{"full_name":{"type":"string","description":"Holder name as published."}}},"location":{"type":"object","properties":{"city":{"type":["string","null"],"description":"City of record."},"region":{"type":["string","null"],"description":"State of record."},"county":{"type":"string","description":"County of record, when available on a scored search or ambiguity response."}}},"match_score":{"type":"integer","minimum":0,"maximum":100,"description":"Name similarity on a scored search or name-verification conflict. Exact normalized names score 100. Nicknames and incomplete or initial-only middle names score lower. Higher scores rank candidates and have no effect on which candidates cause a conflict."}}},"Credential":{"type":"object","description":"A normalized credential with the board-native values kept beside every normalized field.","required":["object","id","jurisdiction","profession","credential_type","credential_class","license_number","holder","status","dates","discipline","provenance"],"properties":{"object":{"const":"credential"},"id":{"type":"string","description":"Credential id."},"jurisdiction":{"type":"object","description":"Issuing state or district.","required":["code","name"],"properties":{"code":{"type":"string","description":"Stable machine code."},"name":{"type":"string","description":"Human-readable label."}}},"profession":{"type":"object","description":"Allied-health profession.","required":["code","name"],"properties":{"code":{"type":"string","description":"Stable machine code.","enum":["physical_therapy","occupational_therapy","respiratory_care","speech_language_pathology","audiology","athletic_training","radiologic_technology","medical_physics","perfusion","surgical_assisting","dietetics","dyslexia_therapy","hearing_instrument_dispensing","orthotics_and_prosthetics"]},"name":{"type":"string","description":"Human-readable label."}}},"credential_type":{"type":"object","description":"Normalized credential type.","required":["code","name"],"properties":{"code":{"type":"string","description":"Stable machine code.","enum":["pt","pta","ot","ota","rt","slp","slpa","aud","auda","at","mrt","nct","ra","pmrt","mp","perf","sa","rd","dt","dp","hid","po","poa"]},"name":{"type":"string","description":"Human-readable label."}}},"credential_class":{"type":"object","description":"License, permit, compact privilege, certification or registration.","required":["code","name"],"properties":{"code":{"type":"string","description":"Stable machine code.","enum":["license","temporary_permit","limited_permit","compact_privilege","certification","registration","telehealth_registration"]},"name":{"type":"string","description":"Human-readable label."}}},"native_type":{"type":"string","description":"The credential type exactly as the board names it."},"license_number":{"type":"string","description":"License number as published."},"holder":{"type":"object","properties":{"full_name":{"type":"string","description":"Full name."},"first_name":{"type":["string","null"],"description":"First name."},"middle_name":{"type":["string","null"],"description":"Middle name or initial."},"last_name":{"type":["string","null"],"description":"Last name."},"suffix":{"type":["string","null"],"description":"Suffix."}}},"status":{"$ref":"#/components/schemas/CredentialStatus"},"dates":{"type":"object","properties":{"first_issued_on":{"type":["string","null"],"description":"Original issue date (YYYY-MM-DD).","format":"date"},"last_renewed_on":{"type":["string","null"],"description":"Most recent renewal or issue date.","format":"date"},"expires_on":{"type":["string","null"],"description":"Expiration date.","format":"date"}}},"discipline":{"type":"object","properties":{"has_public_action":{"type":"boolean","description":"The board shows a public action, complaint or discipline flag."},"actions":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Action type as published."},"case_number":{"type":["string","null"],"description":"Board case number."},"effective_on":{"type":["string","null"],"description":"Effective date.","format":"date"},"completed_on":{"type":["string","null"],"description":"Completion date.","format":"date"},"description":{"type":["string","null"],"description":"Additional detail."},"document_url":{"type":["string","null"],"description":"Link to the board order, when published."}}}}}},"location":{"type":"object","properties":{"city":{"type":["string","null"],"description":"City."},"region":{"type":["string","null"],"description":"State."},"postal_code":{"type":["string","null"],"description":"Postal code."}}},"attributes":{"type":"object","additionalProperties":true,"description":"Source- and specialty-specific fields, such as `ce_due_on`, `specialty`, `degrees` or `subcategory`. Keys are snake_case and stable per source."},"documents":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","description":"Document kind.","enum":["verification_page","profile_page","board_order","search_page"]},"url":{"type":"string","description":"Official URL."},"title":{"type":"string","description":"Label."}}}},"provenance":{"$ref":"#/components/schemas/Provenance"},"compact":{"$ref":"#/components/schemas/CompactEvidence"}},"example":{"object":"credential","id":"cred_4k2m9q0d7f3h1j5n8p6r2t4v0w","jurisdiction":{"code":"WA","name":"Washington"},"profession":{"code":"physical_therapy","name":"Physical therapy"},"credential_type":{"code":"pt","name":"Physical Therapist"},"credential_class":{"code":"license","name":"License"},"native_type":"Physical Therapist License","license_number":"PT.PT.60512345","holder":{"full_name":"Jordan A Rivera","first_name":"Jordan","middle_name":"A","last_name":"Rivera","suffix":null},"status":{"code":"active","name":"Active","native":"Active","is_active":true},"dates":{"first_issued_on":"2019-06-14","last_renewed_on":"2025-05-02","expires_on":"2027-05-02"},"discipline":{"has_public_action":false,"actions":[]},"location":{"city":null,"region":null,"postal_code":null},"attributes":{"ce_due_on":"2027-05-02"},"documents":[{"kind":"search_page","url":"https://wahelms.my.site.com/s/license-search","title":"WA DOH license search"}],"provenance":{"source_id":"wa-doh","authority":"Washington State Department of Health","verification_level":"primary_source","statement":"The department states this data is a primary source for verification of credentials.","source_url":"https://wahelms.my.site.com/s/license-search","observed_at":"2026-11-18T14:02:11.000Z","source_as_of":"2026-11-18T10:00:00.000Z","first_seen_at":"2026-11-18T14:02:11.000Z","last_changed_at":"2026-11-18T14:02:11.000Z","record_hash":"9f2c…"}}},"CredentialStatus":{"type":"object","required":["code","name","native","is_active"],"properties":{"code":{"type":"string","description":"Normalized status.","enum":["active","active_restricted","probation","inactive","expired","suspended","revoked","surrendered","pending","denied","unknown"]},"name":{"type":"string","description":"Label for the normalized status."},"native":{"type":"string","description":"Status exactly as the board publishes it. Never discarded."},"is_active":{"type":"boolean","description":"True for `active`, `active_restricted` and `probation`. It follows the board status. Some rosters keep a license active after `dates.expires_on` until a renewal posts, so compare that date with the check date. Check `discipline` before you make an eligibility decision."}}},"CompactEvidence":{"type":"object","description":"Frozen compact evidence for a license in a compact profession or a compact privilege. Older reports may omit this field.","required":["code","name","lookup_url","home_license","privileges"],"properties":{"code":{"type":"string","description":"Compact identifier.","enum":["pt_compact","ot_compact","aslp_ic"]},"name":{"type":"string","description":"Compact name."},"lookup_url":{"type":"string","description":"Official public compact verification portal.","format":"uri"},"home_license":{"description":"Home license cited by the privilege source, if available. Status is null when there is no unique home license record in covered sources.","oneOf":[{"$ref":"#/components/schemas/CompactCredential"},{"type":"null"}]},"privileges":{"type":"array","description":"Privileges whose source cites this home license. An empty list means no links are known in the data checked.","items":{"$ref":"#/components/schemas/CompactCredential"}}}},"CompactCredential":{"type":"object","required":["state","license_number","status","expires_on","provenance"],"properties":{"state":{"type":"string","description":"Two-letter state code."},"license_number":{"type":"string","description":"License or privilege number as published by the source."},"status":{"oneOf":[{"$ref":"#/components/schemas/CredentialStatus"},{"type":"null"}]},"expires_on":{"type":["string","null"],"description":"Expiration date as published.","format":"date"},"provenance":{"oneOf":[{"$ref":"#/components/schemas/Provenance"},{"type":"null"}]}}},"Provenance":{"type":"object","description":"Where and when the data came from. Every verification keeps this as evidence.","properties":{"source_id":{"type":"string","description":"Source id. See `GET /v1/sources/{id}`."},"authority":{"type":"string","description":"Issuing authority."},"verification_level":{"type":"string","description":"`primary_source`: the authority states this data is primary-source verification. `official_board_data`: official data that is not certified as PSV. `corroborating`: a secondary source.","enum":["primary_source","official_board_data","corroborating"]},"statement":{"type":"string","description":"The authority's own statement about the data, or our description of it."},"source_url":{"type":"string","description":"Where a person can check the record by hand."},"observed_at":{"type":["string","null"],"description":"When we last confirmed this record at the source.","format":"date-time"},"source_as_of":{"type":["string","null"],"description":"The 'data as of' time the source publishes, when it publishes one.","format":"date-time"},"first_seen_at":{"type":["string","null"],"description":"When we first saw this record.","format":"date-time"},"last_changed_at":{"type":["string","null"],"description":"When any field last changed.","format":"date-time"},"record_hash":{"type":"string","description":"SHA-256 of the normalized record. Changes when any field changes."},"detail_observed_at":{"type":["string","null"],"description":"Only for sources that publish dates and public actions on a separate license detail page (Florida). When we last read that page. `null` means the source had no detail page for this license, so dates and public actions were not checked.","format":"date-time"}}},"ExclusionMatch":{"type":"object","properties":{"first_name":{"type":["string","null"],"description":"First name as listed by OIG."},"middle_name":{"type":["string","null"],"description":"Middle name or initial as listed by OIG."},"last_name":{"type":["string","null"],"description":"Last name as listed by OIG."},"business_name":{"type":["string","null"],"description":"Business name as listed by OIG."},"npi":{"type":["string","null"],"description":"National Provider Identifier as listed by OIG."},"specialty":{"type":["string","null"],"description":"Specialty as listed by OIG."},"state":{"type":["string","null"],"description":"State as listed by OIG."},"exclusion_type":{"type":"string","description":"Statutory exclusion code as listed by OIG."},"excluded_on":{"type":"string","description":"Exclusion date.","format":"date"},"reinstated_on":{"type":["string","null"],"description":"Reinstatement date from the monthly supplement, when applicable.","format":"date"}}},"SamExclusionMatch":{"type":"object","properties":{"first_name":{"type":["string","null"],"description":"First name as listed by SAM.gov."},"middle_name":{"type":["string","null"],"description":"Middle name or initial as listed by SAM.gov."},"last_name":{"type":["string","null"],"description":"Last name as listed by SAM.gov."},"business_name":{"type":["string","null"],"description":"Always null. Screening covers individuals."},"npi":{"type":["string","null"],"description":"National Provider Identifier as listed by SAM.gov."},"specialty":{"type":["string","null"],"description":"Always null."},"state":{"type":["string","null"],"description":"Always null."},"exclusion_type":{"type":["string","null"],"description":"Exclusion type or legacy cause and treatment code as listed by SAM.gov."},"excluded_on":{"type":["string","null"],"description":"Date the SAM.gov exclusion became active, when listed.","format":"date"},"reinstated_on":{"type":"null"},"source_record_id":{"type":["string","null"],"description":"SAM number for review in the official source."}}},"ExclusionCheck":{"type":"object","required":["status","match_method","source_as_of","matches","has_more_matches"],"properties":{"status":{"type":"string","description":"`excluded`: current exclusion for the checked NPI. `reinstated`: exact NPI found in the release’s reinstatement supplement. `possible_match`: possible match, review with OIG. `no_match`: no entry matched the available identifiers. `unavailable`: no LEIE release imported. `insufficient_identity`: neither NPI nor name and state available.","enum":["excluded","possible_match","reinstated","no_match","unavailable","insufficient_identity"]},"match_method":{"type":["string","null"],"description":"`npi`: high-confidence exact NPI match. `name_and_state`: possible match by first name, last name and state of record (or issuing state if unavailable). Null when there is no match.","enum":["npi","name_and_state",null]},"source_as_of":{"type":["string","null"],"description":"End of the month covered by the OIG release used for this check.","format":"date-time"},"matches":{"type":"array","items":{"$ref":"#/components/schemas/ExclusionMatch"},"maxItems":25},"has_more_matches":{"type":"boolean","description":"True if more than 25 entries matched."},"sam_gov":{"$ref":"#/components/schemas/SamExclusionCheck"}}},"SamExclusionCheck":{"type":"object","description":"Frozen SAM.gov screening result for individual exclusions. Absent from reports saved before SAM.gov screening was added.","required":["status","match_method","source_as_of","matches","has_more_matches"],"properties":{"status":{"type":"string","description":"`excluded`: active exclusion for the checked NPI. `possible_match`: first and last names match, review with SAM.gov. `no_match`: no entry matched the available identifiers. `unavailable`: no SAM.gov extract imported. `insufficient_identity`: neither NPI nor first and last names available.","enum":["excluded","possible_match","no_match","unavailable","insufficient_identity"]},"match_method":{"type":["string","null"],"description":"`npi`: exact NPI match. `name`: first and last names match. Null when there is no match.","enum":["npi","name",null]},"source_as_of":{"type":["string","null"],"description":"Date of the daily SAM.gov extract used for this check.","format":"date-time"},"matches":{"type":"array","items":{"$ref":"#/components/schemas/SamExclusionMatch"},"maxItems":25},"has_more_matches":{"type":"boolean","description":"True if more than 25 entries matched."}}},"NppesProvider":{"type":"object","required":["npi","taxonomy_codes"],"properties":{"npi":{"type":"string","description":"Individual National Provider Identifier.","pattern":"^[0-9]{10}$"},"first_name":{"type":"string","description":"First name listed in NPPES."},"middle_name":{"type":"string","description":"Middle name listed in NPPES."},"last_name":{"type":"string","description":"Legal last name listed in NPPES."},"suffix":{"type":"string","description":"Name suffix listed in NPPES."},"credential":{"type":"string","description":"Credential text listed in NPPES."},"practice_state":{"type":"string","description":"State of the primary practice location listed in NPPES."},"taxonomy_codes":{"type":"array","items":{"type":"string"}}}},"NpiMatch":{"type":"object","required":["status","supplied_npi","provider","source_as_of"],"properties":{"status":{"type":"string","description":"`matched`: NPPES lists the verified license number and state, and the link is unique or selected by the supplied NPI. `listed`: the supplied NPI is in NPPES without a confirmed license link. `ambiguous`: multiple registry entries list the license. `no_match`: no registry match. `unavailable`: no registry release was available.","enum":["matched","listed","ambiguous","no_match","unavailable"]},"supplied_npi":{"type":["string","null"],"description":"NPI from the request. A confirmed license link takes precedence for exclusion screening."},"provider":{"oneOf":[{"$ref":"#/components/schemas/NppesProvider"},{"type":"null"}]},"source_as_of":{"type":["string","null"],"description":"Date covered by the imported monthly and weekly CMS files.","format":"date-time"}}},"VerificationHints":{"type":"object","description":"Next steps for a completed verification with a `not_found` outcome.","required":["name_search","alternative_credential_types","board_sites"],"properties":{"name_search":{"type":"object","description":"Free name search. Add the required `last_name` and an optional `first_name` to the supplied filters.","required":["path","parameters"],"properties":{"path":{"const":"/v1/credentials"},"parameters":{"type":"object","required":["jurisdiction"],"properties":{"jurisdiction":{"type":"string","description":"Two-letter issuing state code."},"credential_type":{"type":"string","description":"Credential type from the request, when specified."}}}}},"alternative_credential_types":{"type":"array","description":"Other types in the same state with a recognized license number format. Empty when no type was selected or no other format matches.","items":{"type":"object","required":["code","name"],"properties":{"code":{"type":"string","description":"Credential type code."},"name":{"type":"string","description":"Credential type name."}}}},"board_sites":{"type":"array","description":"Official board sites for a manual check.","items":{"type":"object","required":["source_id","authority","url"],"properties":{"source_id":{"type":"string","description":"Source ID."},"authority":{"type":"string","description":"Board or issuing authority."},"url":{"type":"string","description":"Official lookup page.","format":"uri"}}}}}},"Verification":{"type":"object","required":["object","id","status","request","credits_charged","created_at"],"properties":{"object":{"const":"verification"},"id":{"type":"string","description":"Verification id."},"status":{"type":"string","description":"`pending` while a live source lookup runs. `completed` or `failed` when done.","enum":["pending","completed","failed"]},"outcome":{"type":["string","null"],"enum":["found","not_found",null],"description":"Set when `status` is `completed`."},"reference":{"type":["string","null"],"description":"Your own reference, echoed back."},"request":{"type":"object","description":"The normalized request.","additionalProperties":true},"credential":{"oneOf":[{"$ref":"#/components/schemas/Credential"},{"type":"null"}],"description":"A frozen snapshot of the credential at verification time. Later source changes never alter it."},"hints":{"$ref":"#/components/schemas/VerificationHints"},"npi_match":{"oneOf":[{"$ref":"#/components/schemas/NpiMatch"},{"type":"null"}],"description":"Frozen NPPES identity check. Null for pending, failed and older reports saved before NPPES matching was available."},"exclusion_check":{"oneOf":[{"$ref":"#/components/schemas/ExclusionCheck"},{"type":"null"}],"description":"Frozen OIG LEIE screening result with SAM.gov screening under `sam_gov`, included in the verification credit. Null for pending, failed and older reports saved before screening was available."},"credits_charged":{"type":"integer","description":"1 for a completed verification. 0 when it failed (the credit is refunded)."},"failure_reason":{"type":["string","null"],"description":"Why the verification failed."},"created_at":{"type":"string","description":"Creation time.","format":"date-time"},"completed_at":{"type":["string","null"],"description":"Completion time.","format":"date-time"}},"example":{"object":"verification","id":"ver_2h6k9m1n4p7q0r3s5t8v1w4x6y","status":"completed","outcome":"found","reference":"candidate-1042","request":{"jurisdiction":"WA","license_number":"PT60512345","credential_type":"pt"},"credential":{"object":"credential","id":"cred_4k2m9q0d7f3h1j5n8p6r2t4v0w","jurisdiction":{"code":"WA","name":"Washington"},"profession":{"code":"physical_therapy","name":"Physical therapy"},"credential_type":{"code":"pt","name":"Physical Therapist"},"credential_class":{"code":"license","name":"License"},"native_type":"Physical Therapist License","license_number":"PT.PT.60512345","holder":{"full_name":"Jordan A Rivera","first_name":"Jordan","middle_name":"A","last_name":"Rivera","suffix":null},"status":{"code":"active","name":"Active","native":"Active","is_active":true},"dates":{"first_issued_on":"2019-06-14","last_renewed_on":"2025-05-02","expires_on":"2027-05-02"},"discipline":{"has_public_action":false,"actions":[]},"location":{"city":null,"region":null,"postal_code":null},"attributes":{"ce_due_on":"2027-05-02"},"documents":[{"kind":"search_page","url":"https://wahelms.my.site.com/s/license-search","title":"WA DOH license search"}],"provenance":{"source_id":"wa-doh","authority":"Washington State Department of Health","verification_level":"primary_source","statement":"The department states this data is a primary source for verification of credentials.","source_url":"https://wahelms.my.site.com/s/license-search","observed_at":"2026-11-18T14:02:11.000Z","source_as_of":"2026-11-18T10:00:00.000Z","first_seen_at":"2026-11-18T14:02:11.000Z","last_changed_at":"2026-11-18T14:02:11.000Z","record_hash":"9f2c…"}},"exclusion_check":{"status":"no_match","match_method":null,"source_as_of":"2026-10-31T00:00:00.000Z","matches":[],"has_more_matches":false,"sam_gov":{"status":"no_match","match_method":null,"source_as_of":"2026-11-18T00:00:00.000Z","matches":[],"has_more_matches":false}},"credits_charged":1,"failure_reason":null,"created_at":"2026-11-18T14:05:00.000Z","completed_at":"2026-11-18T14:05:00.000Z"}},"Batch":{"type":"object","required":["object","id","status","estimated_credits","credits_charged","rows"],"properties":{"object":{"const":"batch"},"id":{"type":"string","description":"Batch id."},"status":{"type":"string","description":"Poll while processing. Stopped means at least one row was skipped for lack of credits.","enum":["processing","completed","stopped"]},"estimated_credits":{"type":"integer","description":"Upper estimate of credits for rows that passed validation."},"credits_charged":{"type":"integer","description":"Credits used so far, after refunds."},"rows":{"type":"array","items":{"$ref":"#/components/schemas/BatchRow"}}}},"BatchRow":{"type":"object","properties":{"row":{"type":"integer","minimum":1,"description":"Position in the submitted rows, starting at 1."},"input":{"type":"object","description":"Accepted verification input fields.","additionalProperties":{"type":"string"}},"reference":{"type":["string","null"],"description":"Your per-row reference."},"status":{"type":"string","description":"Invalid rows fail input or coverage validation. Failed rows could not be verified. Skipped rows ran out of credits.","enum":["invalid","queued","pending","completed","failed","skipped"]},"outcome":{"type":["string","null"],"enum":["found","not_found",null]},"credits_charged":{"type":"integer"},"verification_id":{"type":["string","null"],"description":"Verification id, when a verification was created."},"verification_url":{"type":["string","null"],"description":"API path to the full verification."},"report_url":{"type":["string","null"],"description":"Browser link to the report. Requires sign-in and report access.","format":"uri"},"error":{"type":["object","null"],"properties":{"type":{"type":"string","description":"Error code."},"message":{"type":"string","description":"Row error."},"param":{"type":["string","null"],"description":"Affected field."},"state_request_url":{"type":"string","description":"Browser path to the state request form, filled in for `unsupported_jurisdiction`.","format":"uri-reference"}}}}},"Source":{"type":"object","description":"An official source for credential verification, provider identity or exclusion screening, with its rights notes.","properties":{"object":{"const":"source"},"id":{"type":"string","description":"Source id."},"name":{"type":"string","description":"Dataset or portal name."},"jurisdiction":{"type":"object","description":"Jurisdiction.","required":["code","name"],"properties":{"code":{"type":"string","description":"Stable machine code."},"name":{"type":"string","description":"Human-readable label."}}},"authority":{"type":"string","description":"Issuing authority."},"verification_level":{"type":"string","description":"See Provenance."},"verification_statement":{"type":"string","description":"The authority's own statement about the data, or our description of it."},"homepage":{"type":"string","description":"The official source."},"credential_types":{"type":"array","items":{"type":"object"},"description":"Credential types this source covers."},"rights":{"type":"object","description":"Data rights for this source."},"records":{"type":"integer","description":"Records held from this source."},"source_as_of":{"type":["string","null"],"description":"For LEIE, the end of the month covered by the current release. For SAM.gov, the date of the daily extract. For NPPES, the date covered by the imported monthly and weekly files. Null before the first import.","format":"date-time"}}},"Account":{"type":"object","properties":{"object":{"const":"account"},"email":{"type":"string","description":"Email of the user who created the API key."},"plan":{"type":["object","null"],"description":"Current plan, or null on the free trial."},"credits":{"type":"object","properties":{"balance":{"type":"integer","description":"Verifications you can run now."},"buckets":{"type":"array","items":{"type":"object"},"description":"Included plan credits are used first, then top-ups."}}}}}}},"tags":[{"name":"Verifications","description":"Paid checks that return a frozen credential snapshot with provenance."},{"name":"Search","description":"Free identity search across the records we hold."},{"name":"Coverage","description":"What is covered, from where, and how fresh it is."},{"name":"Account","description":"Your credit balance and plan."}],"paths":{"/v1/batches":{"post":{"tags":["Verifications"],"summary":"Submit a verification batch","description":"Submit up to 500 rows (256 KiB max). Each row accepts the same fields as a single verification, including your optional reference. Invalid and unsupported rows are kept with their errors and use no credits. Background processing uses the organization's normal verification credits. A completed not_found uses one credit. When the balance runs out, the batch skips the remaining queued rows. Existing pending lookups can still finish.","security":[{"apiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["rows"],"properties":{"rows":{"type":"array","minItems":1,"maxItems":500,"items":{"type":"object","description":"Send `credential_id` from a search result, or `jurisdiction` with either `license_number` or both `first_name` and `last_name`. A name verification searches stored credentials and requires a single match.","properties":{"credential_id":{"type":"string","description":"Credential id from `GET /v1/credentials`."},"jurisdiction":{"type":"string","description":"Two-letter state code.","example":"WA"},"license_number":{"type":"string","description":"License number. For North Carolina, Ohio and Pennsylvania, send the full number with its letters and leading zeros. Other sources may match by digits.","example":"PT60512345"},"first_name":{"type":"string","description":"First name for a name verification. Supports common nicknames and can include a middle name or initial.","maxLength":64},"middle_name":{"type":"string","description":"Optional middle name or initial for a name verification.","maxLength":64},"last_name":{"type":"string","description":"Full last name for a name verification. Ignores case, accents, spaces and punctuation.","maxLength":64},"city":{"type":"string","description":"Filter by normalized board-published city when verifying by name or license number.","maxLength":64},"county":{"type":"string","description":"Filter by board-published county where available. The County suffix is optional.","maxLength":64},"credential_type":{"type":"string","description":"Narrow the match to one credential type. Required with a North Carolina license number to select the correct board.","enum":["pt","pta","ot","ota","rt","slp","slpa","aud","auda","at","mrt","nct","ra","pmrt","mp","perf","sa","rd","dt","dp","hid","po","poa"]},"npi":{"type":"string","description":"Optional National Provider Identifier for registry matching and federal exclusion screening. For name verification it also requires a board NPI or a current NPPES link to the same license number and issuing state. A confirmed match can also narrow a license-number conflict.","pattern":"^[0-9]{10}$"},"reference":{"type":"string","description":"Your own id for this check (for example a candidate id). Max 200 characters."}}}}}},"example":{"rows":[{"jurisdiction":"WA","license_number":"PT60512345","reference":"candidate-1042"}]}}}},"responses":{"202":{"description":"Accepted for background processing.","headers":{"Location":{"description":"Poll this path for results.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Batch"}}}},"400":{"description":"Invalid batch body or row count.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"413":{"description":"The body exceeds 256 KiB.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/batches/{id}":{"get":{"tags":["Verifications"],"summary":"Retrieve batch results","description":"Poll every 10 seconds while the batch is processing. Returns all rows in submission order. Completed and stopped batches are terminal.","security":[{"apiKey":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Current batch results.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Batch"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No batch in the API key's organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/verifications":{"post":{"tags":["Verifications"],"summary":"Verify a credential","description":"Uses one credit from the API key’s organization and includes OIG LEIE and SAM.gov exclusion screening. Returns `201` with `status: completed` when we already hold a current credential. Returns `202` with `status: pending` when the source needs a live lookup, or when a Florida license has no fetched detail page yet (dates and public actions come only from that page); poll `GET /v1/verifications/{id}` every few seconds until it completes. Pennsylvania name queries search previously checked records. Use the full license number to look up a new Pennsylvania credential. If a live lookup fails, the verification fails and the credit is refunded. A completed `not_found` outcome uses the credit.","security":[{"apiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Send `credential_id` from a search result, or `jurisdiction` with either `license_number` or both `first_name` and `last_name`. A name verification searches stored credentials and requires a single match.","properties":{"credential_id":{"type":"string","description":"Credential id from `GET /v1/credentials`."},"jurisdiction":{"type":"string","description":"Two-letter state code.","example":"WA"},"license_number":{"type":"string","description":"License number. For North Carolina, Ohio and Pennsylvania, send the full number with its letters and leading zeros. Other sources may match by digits.","example":"PT60512345"},"first_name":{"type":"string","description":"First name for a name verification. Supports common nicknames and can include a middle name or initial.","maxLength":64},"middle_name":{"type":"string","description":"Optional middle name or initial for a name verification.","maxLength":64},"last_name":{"type":"string","description":"Full last name for a name verification. Ignores case, accents, spaces and punctuation.","maxLength":64},"city":{"type":"string","description":"Filter by normalized board-published city when verifying by name or license number.","maxLength":64},"county":{"type":"string","description":"Filter by board-published county where available. The County suffix is optional.","maxLength":64},"credential_type":{"type":"string","description":"Narrow the match to one credential type. Required with a North Carolina license number to select the correct board.","enum":["pt","pta","ot","ota","rt","slp","slpa","aud","auda","at","mrt","nct","ra","pmrt","mp","perf","sa","rd","dt","dp","hid","po","poa"]},"npi":{"type":"string","description":"Optional National Provider Identifier for registry matching and federal exclusion screening. For name verification it also requires a board NPI or a current NPPES link to the same license number and issuing state. A confirmed match can also narrow a license-number conflict.","pattern":"^[0-9]{10}$"},"reference":{"type":"string","description":"Your own id for this check (for example a candidate id). Max 200 characters."}}},"example":{"jurisdiction":"WA","license_number":"PT60512345","credential_type":"pt","reference":"candidate-1042"}}}},"responses":{"201":{"description":"Completed verification.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Verification"}}}},"202":{"description":"Pending live lookup.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Verification"}}}},"400":{"description":"Invalid request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"No credits remain.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Unknown credential_id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"More than one credential matches. The response includes masked candidates and suggested fields. No credit is used.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"The jurisdiction or credential type is not covered. No credit is used.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"get":{"tags":["Verifications"],"summary":"List verifications","description":"Lists verification history for the API key’s organization.","security":[{"apiKey":[]}],"parameters":[{"name":"q","in":"query","required":false,"description":"Substring of the saved holder name or the saved or requested license number. Ignores case for A–Z.","schema":{"type":"string"}},{"name":"jurisdiction","in":"query","required":false,"description":"Two-letter issuing state code.","schema":{"type":"string"}},{"name":"status","in":"query","required":false,"description":"Verification processing status.","schema":{"type":"string","enum":["pending","completed","failed"]}},{"name":"outcome","in":"query","required":false,"description":"Verification result.","schema":{"type":"string","enum":["found","not_found"]}},{"name":"credential_status","in":"query","required":false,"description":"License status in the saved report.","schema":{"type":"string","enum":["active","active_restricted","probation","inactive","expired","suspended","revoked","surrendered","pending","denied","unknown"]}},{"name":"reference","in":"query","required":false,"description":"Exact, case-sensitive customer reference.","schema":{"type":"string"}},{"name":"from","in":"query","required":false,"description":"First creation date to include (UTC).","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","required":false,"description":"Last creation date to include (UTC).","schema":{"type":"string","format":"date"}},{"name":"sort","in":"query","required":false,"description":"Order by creation date. Default newest.","schema":{"type":"string","enum":["newest","oldest"]}},{"name":"limit","in":"query","required":false,"description":"1–100. Default 25. Larger values return 100. Other values return `400`.","schema":{"type":"integer"}},{"name":"starting_after","in":"query","required":false,"description":"Cursor from a previous page with the same filters and sort. A malformed cursor returns `400`.","schema":{"type":"string"}}],"responses":{"200":{"description":"Matching verifications, ordered by creation date.","content":{"application/json":{"schema":{"type":"object","required":["object","data","has_more"],"properties":{"object":{"const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Verification"}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"],"description":"Pass as `starting_after` to fetch the next page."}}}}}},"400":{"description":"Invalid filter or date range.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/verifications/{id}":{"get":{"tags":["Verifications"],"summary":"Retrieve a verification","description":"Retrieves a verification from the API key’s organization.","security":[{"apiKey":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The verification.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Verification"}}}},"404":{"description":"Not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/credentials":{"get":{"tags":["Search"],"summary":"Search credentials","description":"Free, masked name search. The default matches name prefixes. Set `fuzzy=true` for scored search by normalized full last name, with optional first and middle names. Supplying `middle_name`, `city`, `county` or `npi` also enables scored search. Scored search ignores case, accents and hyphens, and can match common nicknames and middle initials. Verify a result with its `credential_id`. A `license_number` or `status` search parameter returns `400`.","security":[{"apiKey":[]}],"parameters":[{"name":"last_name","in":"query","required":false,"description":"Last-name prefix by default. Full last name in scored search. Use at least two letters.","schema":{"type":"string"}},{"name":"first_name","in":"query","required":false,"description":"First-name prefix by default. Full first name or nickname in scored search.","schema":{"type":"string"}},{"name":"middle_name","in":"query","required":false,"description":"Middle name or initial. Requires first_name and enables scored search.","schema":{"type":"string"}},{"name":"fuzzy","in":"query","required":false,"description":"Enable scored search.","schema":{"type":"boolean","default":false}},{"name":"city","in":"query","required":false,"description":"Normalized board-published city of record. Enables scored search.","schema":{"type":"string"}},{"name":"county","in":"query","required":false,"description":"Board-published county of record, when available. The County suffix is optional. Enables scored search.","schema":{"type":"string"}},{"name":"npi","in":"query","required":false,"description":"Subject’s NPI. Requires a board NPI or a current NPPES link to the license and issuing state. Enables scored search.","schema":{"type":"string","pattern":"^[0-9]{10}$"}},{"name":"jurisdiction","in":"query","required":false,"description":"Two-letter state code.","schema":{"type":"string"}},{"name":"credential_type","in":"query","required":false,"description":"Credential type code.","schema":{"type":"string","enum":["pt","pta","ot","ota","rt","slp","slpa","aud","auda","at","mrt","nct","ra","pmrt","mp","perf","sa","rd","dt","dp","hid","po","poa"]}},{"name":"profession","in":"query","required":false,"description":"Profession code.","schema":{"type":"string","enum":["physical_therapy","occupational_therapy","respiratory_care","speech_language_pathology","audiology","athletic_training","radiologic_technology","medical_physics","perfusion","surgical_assisting","dietetics","dyslexia_therapy","hearing_instrument_dispensing","orthotics_and_prosthetics"]}},{"name":"limit","in":"query","required":false,"description":"1–100. Default 25. Larger values return 100. Other values return `400`.","schema":{"type":"integer"}},{"name":"starting_after","in":"query","required":false,"description":"Cursor from a previous page. A malformed cursor returns `400`.","schema":{"type":"string"}}],"responses":{"200":{"description":"Matches in name order by default, or by descending match score with name order for ties.","content":{"application/json":{"schema":{"type":"object","required":["object","data","has_more"],"properties":{"object":{"const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CredentialSummary"}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"],"description":"Pass as `starting_after` to fetch the next page."}}}}}},"400":{"description":"Invalid search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/coverage":{"get":{"tags":["Coverage"],"summary":"Coverage matrix","description":"One row per jurisdiction, credential type and source. California uses monthly DCA rosters. Texas uses the Texas Medical Board roster and TDLR license files. Texas physical and occupational therapy credentials remain outside coverage. New York covers radiologic technologist registration from the weekly Department of Health roster. Verify NY radiologic technologists by license number. Illinois uses the IDFPR open-data roster, which can omit licenses, including occupational therapy licenses. Use full nine-digit Illinois license numbers. For Illinois radiologic technologists, the IEMA-OHS directory checks the exact accreditation number. Ohio imports the DataOhio eLicense roster with a public action indicator. The separate Ohio ODH radiologic roster lists the license category and omits status, dates and actions. New Jersey imports the dated DCA individual roster and its discipline indicator. Use the full New Jersey license number. New Jersey radiologic technology is verified separately through NJDEP. Michigan imports the LARA FOIA license lists daily. They include only current licenses, and a suspended or disciplinary limited status sets the public action flag. Use the full 10-digit Michigan license number.","responses":{"200":{"description":"Coverage rows."}}}},"/v1/sources":{"get":{"tags":["Coverage"],"summary":"List sources","description":"Every source with its verification level, credential types and rights notes.","responses":{"200":{"description":"Sources.","content":{"application/json":{"schema":{"type":"object","required":["object","data","has_more"],"properties":{"object":{"const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Source"}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"],"description":"Pass as `starting_after` to fetch the next page."}}}}}}}}},"/v1/sources/{id}":{"get":{"tags":["Coverage"],"summary":"Retrieve a source","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The source.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Source"}}}},"404":{"description":"Not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/catalog":{"get":{"tags":["Coverage"],"summary":"Code catalog","description":"Every profession, credential type, credential class and status code the API can return.","responses":{"200":{"description":"Catalog."}}}},"/v1/account":{"get":{"tags":["Account"],"summary":"Retrieve your account","description":"Returns the API key’s organization plan and credits. The email identifies the user who created the key.","security":[{"apiKey":[]}],"responses":{"200":{"description":"Plan and credits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}}}}}}}