License Verification

get

Retrieve all License Verification Orders

Authorizations

AuthorizationstringRequired

Header parameters

LenderIdstringRequired

Lender ID provided by Verdata

Responses

200

License Verification Orders

application/json

get

/license-verification

GET /external/api/v1/license-verification HTTP/1.1
Host: api.myverdata.com
Authorization: YOUR_API_KEY
LenderId: text
Accept: */*

200

License Verification Orders

{
  "order_id": "123e4567-e89b-12d3-a456-426614174000",
  "input_licensee_subcategory": "text",
  "order_status": "text",
  "item_status": "text",
  "output_order_labels": [
    "text"
  ],
  "output_item_labels": [
    "text"
  ],
  "output_licensee_name": "text",
  "output_licensee_number": "text",
  "output_license_authority_board": "text",
  "output_licensee_category": "text",
  "output_licensee_type_asis": "text",
  "output_issuing_authority": "text",
  "output_license_status": "text",
  "output_license_status_asis": "text",
  "output_license_exp_date": "2025-12-06",
  "output_license_issue_date": "2025-12-06",
  "classification": "text",
  "specialization": "text"
}

post

Sending in the Licensee information on a business will trigger a License Verification Pipeline to check the validity of the Home Services or Healthcare License passed through. The licensee_category must be 'homeServices' or 'healthcare.'
If the license verification request is successful, the endpoint will return a list of verification payloads for the license(s) submitted. The returned payload will initially have fields blank because we are waiting for the license to be verified. As far as getting the actual verified license info back, there are a few ways. The first is through providing a callback endpoint where once the license verification is complete we will send back the verification order payload to your endpoint. The two other ways are using the GET endpoints. You can get the verification payloads by the seller_id or the order_id. The seller_id is a unique identifier for a seller, and the order_id is a unique identifier for a verification request order. The license verification orders will be included in the Seller Report payloads if you decide to grab the entire report for a seller.
For homeServices verification orders licensee_id is required. For healthcare verification orders, if licensee_id is not available, there is a separate workflow. We allow the client to submit licensee information about a medical professional and we will attempt to match it to a doctor in our database. Then, we grab all of the available licenses for that doctor to verify. Ultimately, if the client goes through this workflow then multiple license verification payloads may be returned. To narrow down the list of the licenses to verify, say you only want to verify their "dentistry" related licenses. This is where the licensee_subcategory input field comes in. We will filter those licenses based on the subcategory submitted and only verify those licenses. If the licensee_subcategory field is Null or empty, we will submit all of the doctor's licenses for verification. If a licensee_subcategory is specified and a doctor has licenses that do not fall under that subcategory, we will return a list of valid subcategories that the doctor does have licenses under.
Sample return for where doctor has licenses outside of licensee_subcategory submitted: {"status": "Failed to find licenses in input subcategory of 'dentistry'", "suggested_subcategories": ["dietary_nutrition","lactation"]}
When inputting a licensee_subcategory, there is a list of valid subcategories: ["physicians", "counseling_psychology_therapy", "chiropractic", "dentistry", "dietary_nutrition", "optometry", "podiatry", "pt_ot", "speech_language_hearing", "diagnostic_imaging", "lactation", "acupuncture"].
Any failures to submit a license verification order will have a response of {'status': 'Failed to verify licenses'} with a 400 HTTP response.

Authorizations

AuthorizationstringRequired

Header parameters

LenderIdstringRequired

Lender ID provided by Verdata

Body

seller_idstring · uuidRequired

licensee_namestring · min: 1Required

licensee_statestring · min: 1Required

licensee_idstring · min: 1Optional

This is required for Home Service Licensing

licensee_categorystring · min: 1Required

This value must be either 'homeServices' or 'healthcare'

licensee_subcategorystring · min: 1Optional

Not required but if provided there are a list of possible inputs

licensee_addr1string · min: 1Optional

licensee_citystring · min: 1Optional

licensee_zip5string · min: 1Optional

callback_urlstring · min: 1Optional

This parameter will allow us to respond with the complete verification once done

Responses

200

License Verification Order

application/json

post

/license-verification

POST /external/api/v1/license-verification HTTP/1.1
Host: api.myverdata.com
Authorization: YOUR_API_KEY
LenderId: text
Content-Type: application/json
Accept: */*
Content-Length: 269

{
  "seller_id": "123e4567-e89b-12d3-a456-426614174000",
  "licensee_name": "text",
  "licensee_state": "text",
  "licensee_id": "text",
  "licensee_category": "text",
  "licensee_subcategory": "text",
  "licensee_addr1": "text",
  "licensee_city": "text",
  "licensee_zip5": "text",
  "callback_url": "text"
}

200

License Verification Order

[
  {
    "order_id": "123e4567-e89b-12d3-a456-426614174000",
    "input_licensee_subcategory": "text",
    "order_status": "text",
    "item_status": "text",
    "output_order_labels": [
      "text"
    ],
    "output_item_labels": [
      "text"
    ],
    "output_licensee_name": "text",
    "output_licensee_number": "text",
    "output_license_authority_board": "text",
    "output_licensee_category": "text",
    "output_licensee_type_asis": "text",
    "output_issuing_authority": "text",
    "output_license_status": "text",
    "output_license_status_asis": "text",
    "output_license_exp_date": "2025-12-06",
    "output_license_issue_date": "2025-12-06",
    "classification": "text",
    "specialization": "text"
  }
]

get

Retrieve a License Verification Order by Order ID. If sent in a Healthcare verification order and multiple licenses were ran for a healthcare professional, will return all licenses for that request.

Authorizations

AuthorizationstringRequired

Path parameters

idanyRequired

Header parameters

LenderIdstringRequired

Lender ID provided by Verdata

Responses

200

License Verification Order

application/json

get

/license-verification/order/{id}

GET /external/api/v1/license-verification/order/{id} HTTP/1.1
Host: api.myverdata.com
Authorization: YOUR_API_KEY
LenderId: text
Accept: */*

200

License Verification Order

[
  {
    "order_id": "123e4567-e89b-12d3-a456-426614174000",
    "input_licensee_subcategory": "text",
    "order_status": "text",
    "item_status": "text",
    "output_order_labels": [
      "text"
    ],
    "output_item_labels": [
      "text"
    ],
    "output_licensee_name": "text",
    "output_licensee_number": "text",
    "output_license_authority_board": "text",
    "output_licensee_category": "text",
    "output_licensee_type_asis": "text",
    "output_issuing_authority": "text",
    "output_license_status": "text",
    "output_license_status_asis": "text",
    "output_license_exp_date": "2025-12-06",
    "output_license_issue_date": "2025-12-06",
    "classification": "text",
    "specialization": "text"
  }
]

get

Retrieve all License Verification Orders by Seller ID. Will only return orders that the client have submitted.

Authorizations

AuthorizationstringRequired

Path parameters

seller_idanyRequired

Header parameters

LenderIdstringRequired

Lender ID provided by Verdata

Responses

200

License Verification Order

application/json

get

/license-verification/seller/{seller_id}

GET /external/api/v1/license-verification/seller/{seller_id} HTTP/1.1
Host: api.myverdata.com
Authorization: YOUR_API_KEY
LenderId: text
Accept: */*

200

License Verification Order

[
  {
    "order_id": "123e4567-e89b-12d3-a456-426614174000",
    "input_licensee_subcategory": "text",
    "order_status": "text",
    "item_status": "text",
    "output_order_labels": [
      "text"
    ],
    "output_item_labels": [
      "text"
    ],
    "output_licensee_name": "text",
    "output_licensee_number": "text",
    "output_license_authority_board": "text",
    "output_licensee_category": "text",
    "output_licensee_type_asis": "text",
    "output_issuing_authority": "text",
    "output_license_status": "text",
    "output_license_status_asis": "text",
    "output_license_exp_date": "2025-12-06",
    "output_license_issue_date": "2025-12-06",
    "classification": "text",
    "specialization": "text"
  }
]

PreviousGenerate PDF NextOn Demand Merchant

Last updated 11 days ago

Good night