For all requests, request header Api-Key is required with valid API key.

Get types of licenses for the state

Get the list of avaible licenses for a given state, in case of your application allowing multiple types of licenses.

Endpoint

GET /licenses/:state

Parameters

Parameter Type Description Required
state String The U.S state. Yes

Response Example


[
    "Accountancy",
    "Architect",
    "Automotive",
    "Acupuncture",
    "BAR",
    "Behavior Science"
    "Cosmetology",
    "Chiropractic",
    "Dental",
    "Household",
    "Landscape",
    ...
]

Get license requirments

Get required fields from use to verify the license.

Endpoint

GET /licenses/:state/requirements/:license

Parameters

Parameter Type Description Required
state String The U.S state. Yes
license String License type. Yes

Response Example


{ 
    required : [
        { 
            name : 'Juris Number', type : 'Number'
        }
    ], 
    optional : [
        { 
            name : 'First Name', type : "String"
        },
        {
            name : 'Last Name', type : 'String'
        }
    ]
}
There are 3 types for requirments fields Number, String and Date.
- String any combination of characters.
- Number is expected to be a whole integer.
- Date Please refer to simplification of the ISO 8601 calendar date extended format. for expected date string format. Example: YYYY-MM-DD
Use types to build user input forms, name field is the user friendly of the data point to be requested from user.

Order license verification

Get current status of the license.

Endpoint

POST /order

Body (JSON)

Key Type Description Required
state String U.S State in which license is issued. Yes
license Object Object with required and optional fields. Yes
licenseType String Type of the license. Yes
callback String URL to wich make a request to deliver the result of verification. Yes
payload Object Object to attach to the callback's POST body. Optional

Getting results

A callback is initiated to sepcified URL. In case of fail callback will be retried up to 3 times 15 min interval between.

Callback Example


{
    "status": "Valid",
    "dataMatch": "Full match"
}
Possible results for status field :
"Valid" License was located and it's currently active.
"Invalid" License was located and it's currently not in the active state.
"Not found" License was not found based on the data provided.

If optional fields were provided and license is active dataMatch will be attached to result object with possible results:
"Full match" All optional fields match with the license data.
"Partial match" Some optional fields matched but not all.
"Mismatch" Provided optional data did not match with data on the license.
With payload

{
    "status": "Valid",
    "dataMatch": "Full match",
    "payload" : {
        "id" : 1,
        .........
        Your JSON object here.
    }
}
Not found

{
    "status": "Not found"
}
Valid with partial match.

{
    "status": "Valid",
    "dataMatch": "Partial match"
}