Submitting New Licenses

To submit a new license for verification, you must first identify the seller the license will be associated with. This is a two-step process:

1. Find Seller

Before submitting a license, locate the correct seller through the seller-detailed endpoint.

  • From the response, copy the seller_id from the Seller Report.

  • This value is required in the next step.

POST /external/api/v1/seller-detailed

2. Submit License for Verification

Once you have the seller_id, submit the licensee to the license-verification endpoint.

GET /external/api/v1/license-verification

Submitting Licensee information for a business triggers Verdata's License Verification Pipeline, which validates the provided Home Services or Healthcare license.

Required Fields

  • seller_id

  • licensee_category must be either:

    • "homeServices"

    • "healthcare"

Home Services Licenses

The required fields for verifying Home Services licenses are:

  • LenderId

  • seller_id - this should be the id returned from the SellerDetailedSearch endpoint

  • licensee_name

  • licensee_state

  • licensee_id

  • licensee_category: homeServices

Healthcare Licenses

Healthcare License Verification operates slightly different from Home Services License Verification in that license_id is recommended but not required.

The required fields for verifying Home Services licenses are:

  • LenderId

  • seller_id - this should be the id returned from the Seller Search endpoint

  • licensee_name

  • licensee_state

  • licensee_category: healthcare

When license_id is not provided for Healthcare Licenses

Verdata will compare the submitted information against the NPI database to retrieve the licenses for the closest matching doctor to the details provided. To ensure the right doctor is selected, it is recommended to submit additional address details such as licensee_addr1, licensee_city, and licensee_zip5 .

It is possible for multiple licenses to return for a single doctor from the NPI database. If the field licensee_subcategory is left Null or empty, the system will create a verification order for each license. To filter out licenses for verification, license_subcategory will accept the following inputs: ["physicians", "counseling_psychology_therapy", "chiropractic", "dentistry", "dietary_nutrition", "optometry", "podiatry", "pt_ot", "speech_language_hearing", "diagnostic_imaging", "lactation", "acupuncture"]

If subcategory is submitted and only licenses matching a different subcategory exist, the return would look like:

{"status": "Failed to find licenses in input subcategory of 'physicians'", 
"suggested_subcategories": ["dietary_nutrition"]}

Upon submission, the API will return a list of verification payloads for the submitted licenses. Note: These payloads will have blank fields initially while the verification is in progress.

Last updated