Welcome to our developer portal. This portal contains all the tools and resources you need to build and integrate our capabilities into your own projects. Whether you're a seasoned developer or just getting started, our portal makes it easy to take advantage of the powerful functionality our software has to offer. With detailed documentation, sample code, and technical support, you'll be able to get up and running in no time.
\nThe endpoints documented are available for our customers to do custom integrations for complex workflows and processing.
\nThe following are some common design considerations when integrating with the API.
\nDates are represented as strings in the ISO 8601 format. This format is both human-readable and easily parsed by machines. Here’s an example of a date string in ISO 8601 format:
\n {\n \"date\": \"2024-09-20\",\n \"datatime\": \"2024-09-20T10:56:33-07:00\"\n }\n\nYYYY: Four-digit year (e.g., 2024)
\nMM: Two-digit month (01-12)
\nDD: Two-digit day of the month (01-31)
\nT: Separator indicating the start of the time component
\nhh: Two-digit hour (00-23)
\nmm: Two-digit minute (00-59)
\nss: Two-digit second (00-59)
\nZ: Indicates UTC time (can also be a timezone offset like +00:00)
For more information on License Number Formats visit the SambaSafety Knowledge Base:
\n\nAn email must be a valid email address, and can contain the following special characters: +,.,-,_,@
The first, middle, and last name values may not contain special characters other than a hyphen - between family surnames OR apostrophe.
Unacceptable characters: á, é, í, ó, ú, ñ, ü,
The suffix field does not accept comma's or periods.
\nThe ssn parameter accepts the 000000000 or 0000 numeric formats. You may need to remove - characters, when formatting this parameter.
The following documentation identifies the common error codes and messages you may encounter when interacting with our API endpoints. There are three main categories of error types we can return from our API. These errors include:
\n4XX Client Side Errors
\n5XX Server Side Errors
\nApplication Errors
\nRequired Fields: A 4XX client side error will be returned if a request is made that does not include all required properties.
\nProvided Fields are Invalid: A 4XX client sidde error will be returned if a request is made with an invalid property formats.
\nProvided Fields are Invalid for State: An application error will be returned if a request is made and the license number format does not match the state requirement.
\nThis lists errors by their HTTP status codes as defined in RFC 7231.
\n4XX client side errors can be corrected and resubmitted to the application.
\nA 400 bad request error is an HTTP status code that indicates that a application is unable to process a request due to a client’s malformed request.
\nCauses:
\nMalformed request syntax; For example, a missing comma or { }.
\nInvalid request body message; For example, a missing required property.
\nTypos in the URL
\nSuggested Action: Check the request, and retry.
\nThe 401 Unauthorized error is an HTTP status code that indicates a client side error when a request to a web server is unsuccessful due to missing or incorrect authentication credentials. The 403 Forbidden is a similar HTTP status code, but the client does not have permissions to perform a certain action.
\nCauses:
\nYou do not have valid credentials (Bearer Token)
\nTrying to access unauthorized data
\nSuggested Action: The most common reason for this is an expired bearer token, re-authenticate to refresh your token.
\nThe 404 Not Found error is an HTTP status code that indicates the server is unable to find the requested resource at a specific endpoint.
\nCauses:
\nSuggested Action: Check the resource id, and retry. If still not found, check resource has not been deleted or moved.
\nThis response is sent when the application doesn't find a matching Content-Type for the requested `Accepted` header.
Causes:
\nAcceptheader.Suggested Action: Check the Acceptbeing sent in the header, and retry.
This response is sent when a request conflicts with the current state of the application data.
\nCauses:
\nSuggested Action: Correct the property value as indicated in the error message, and retry.
\nThe request was well-formed but the application was unable process due to semantic errors.
\nCauses:
\nSuggested Action: Correct the property value as indicated in the error message, and retry.
\nThis status code indicates to the client to slow down the rate of requests is commonly called \"rate limiting\".
\nCauses:
\nSuggested Action: Adjust your application's rate of requests being sent.
\nGenerated based on business/domain rules. An example of an error code returned when the characters submitted in the license state field didn’t match the required format.
\n{\n \"code\": \"B02\",\n \"message\": \"Format for field(s) licenseState are invalid\"\n}\n\nGenerated by the application framework in some scenarios. An example is outlined below
\n{ \n \"timestamp\": \"2024-04-11T18:16:28.810+00:00\", \n \"status\": 404, \n \"error\": \"Not Found\", \n \"path\": \"/v1/mvrorxxxx\" \n}\n\n5XX server side errors can be resubmitted unchanged to the application after a short period of time.
\nThe application has encountered a situation it does not know how to handle.
\nThis error response means that the application, while working as a gateway to get a response needed to handle your request, got an invalid response.
\nThe application is not ready to handle the request. Common causes are a server that is down for maintenance or that is overloaded.
\nThis error response is given when the application does not response in time.
\nApplications errors are returned with the normal HTTP 200 OK response code. These are successfully submitted requests that during the application’s workflow returns a backend error message.
\nOrder errors can occur when the request doesn’t meet a state's requirements. Some examples include:
\nordering a product not available for in that particular state.
\nnot having a state-access code correctly configured in your request. (UT, CA, PA)
\nordering an online vs overnight product (HI)
\nFor more information on MVR Order Errors visit the SambaSafety Knowledge Base
\nTo determine whether it is a no‐hit error, look for a value of N in the Valid property of the Result object. If found, look for one of the values listed below in the ErrorDescription property.
\nJSON 2.0.4 Driver Not Found Example Response
\n{\n \"Record\": {\n \"DlRecord\": {\n \"Criteria\": {\n ...\n },\n \"Result\": {\n \"Control\": \"07GRG8\",\n \"Valid\": \"N\",\n \"ErrorCode\": \"A2\",\n \"ErrorDescription\": \"DRIVER NOT FOUND\",\n \"ReturnedDate\": {...},\n \"ReturnedTime\": {...},\n \"CompanyClass\": \"NO RECORD FOUND AT THE DMV\",\n \"CompanyScore\": \"2\",\n \"CompanyScoreInt\": 2,\n \"CompanyVersion\": \"1-13\",\n \"ReklamiErrorCode\": \"MV\",\n \"ResultCode\": \"RC\",\n \"Designation\": \"ERROR\"\n }\n }\n }\n}\n\nJSON 3.0.0 Driver Not Found Example Response
\n{\n \"mvrId\": \"c2c489c5-6629-4cb0-8bc7-30ba33076507\",\n \"controlNumber\": \"HV0W0W\",\n \"mvrOrder\": {\n \"orderDateTime\": \"2024-08-08T06:53:00-07:00\",\n \"person\": {\n \"firstName\": \"JOHN\",\n \"lastName\": \"PUBLIC\",\n \"birthDate\": \"1980-10-19\"\n },\n \"license\": {\n \"licenseNumber\": \"C012345678\",\n \"licenseState\": \"CO\"\n }\n },\n \"mvrOrderResult\": {\n \"orderDateTime\": \"2024-08-08T06:53:00-07:00\",\n \"productID\": \"DL\",\n \"valid\": \"N\",\n \"response\": \"LICENSE AND NAME OR DOB DO NOT MATCH\",\n \"returnedDateTime\": \"2024-08-08T06:53:00-07:00\"\n }\n}\n\nUnfortunately there are times when the application is down. Network issues, system updates, and planned maintenance times can cause a system down response.
\nFor more information on MVR Platform Status visit the SambaSafety Knowledge Base
\nJSON 2.0.4 System Down Example Response
\n{\n \"Record\": {\n \"DlRecord\": {\n \"Criteria\": {\n ...\n },\n \"Result\": {\n \"Control\": \"07GRG9\",\n \"Valid\": \"N\",\n \"ErrorCode\": \"ZD\",\n \"ErrorDescription\": \"SYSTEM IS DOWN\",\n \"ReturnedDate\": {...},\n \"ReturnedTime\": {...},\n \"ResultCode\": \"13\",\n \"Designation\": \"\"\n }\n }\n }\n}\n\nThis collection can be used with your SambaSafety credentials in both our Demo or Production environments. We offer this collection publicly to assist you in implementing your solution with our APIs. It's meant to jump start your exploration.
\nThis collection can be forked, copied or imported into your own team workspace.
\nSambaSafety has a demo system that will allow you to simulate the process of sending orders and getting reports during your development phase. This environment contains sample data that will allow you to verify the entire process without actually incurring state fees charges. Our demo environment will simulate the same connectivity/security behavior you will encounter when you send orders to our production system.
In addition, you will be able to exercise error handling and token management. This system is not designed to facilitate stress testing. This environment is completely independent of our production system, so your demo account credentials will contain a different account than your production account.
Once you have your demo system credentials you are free to begin connecting to our demo environment.
\nHere are some best practices to follow when you demo and share APIs with customers:
\nEnsure that no API keys are exposed during the demo. Always use environment variables for authentication.
\nWhen sharing environments with customers, ensure it doesn't contain any API keys.
\nIf you need to share the same collection with customers repeatedly, consider sharing it using a public workspace. Alternatively, you can export and share collections and environments.
\nThis collection looks for these environment variables. You can duplicate an environment in your workspace as many times as needed.
\nThis collections contains some predefined groovy scripts to collect the key id variables to update variables in this collection.
pm.test(\"Order Created\", () => {\n pm.expect(pm.response.code).to.eql(201);\n pm.response.to.have.header(\"Content-Type\");\n pm.collectionVariables.set(\"orderId\", pm.response.json().orderId);\n});\n\n(Required) The unique identifier of the platform organization
\n"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","description":"(Required) Type of credentials requesting.
\n"},{"key":"scope","value":"API","description":"(Required) The scopes being requested.
\n"}]},"url":"{{baseUrl}}/oauth2/v1/token","description":"This endpoint allows you login and obtain a bearer token from SambaSafety.
\nContent-Type: application/x-www-form-urlencoded
Authorization: Basic [encoded Client ID & Client Secret]
Accept: application/json
X-Api-Key: [ApiKey]
Parameters:
\ngrant_type (string, required): The type of credentials. client_credentials
scope (string, requied): The scope being requested. API
Upon successful addition of the group, the API will respond with 200 OK containing a token.
\ntoken_type (string): The type of token issued.
expires_in (number): The time-to-live (seconds) for the token.
access_token (string): The token to be used for future calls.
scope (string): The scope granted.
(Required) The unique identifier of the platform organization
\n"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"token","value":"eiusmod labore sit proident voluptate","description":"(Required) The token to revoke.
\n"}]},"url":"{{baseUrl}}/oauth2/v1/revoke","description":"Revoke a bearer token to invalidate it.
\n","auth":{"type":"apikey","apikey":{"key":"Our Authentication approach is based on an agreement with our customers that access to SambaSafety protected resources will be by way of secure server to server interactions between our customers and SambaSafety. In addition, we understand that the customer is the resource owner so no end-user authorization to SambaSafety protected resources is needed. Given these criteria, we have adopted the oAuth2 Client Credential flow.
\nSambaSafety APIs will not be exposed directly through a browser, tokens issued by SambaSafety will not be shared outside of a secure network and client credentials (e.g. clientId and clientSecret) will not be shared outside of a network and will be managed in secure storage. API calls are secured with transport layer encryption and client credentials are encrypted at rest using AES 256
\nWe will return 401 Unauthorized responses to any request made from a domain that is not a SambaSafety domain when requests originate from a browser. This is enforced through CORS policies.
\nAny risk exposure would be the result of a customer’s security perimeter being exploited by an attacker to obtain a token or gain access to the client credentials.
\nBased on this more limited exposure, we have adopted a token expiration of 1 hour. In the event that there is an exploit, we also expose an API endpoint that will allow an authorized client to revoke a token.
\nOur API Gateway is in place to monitor and log traffic to the API.
\nAn API Gateway Key is a code used to identify and authenticate an application attempting to access the API. SambaSafety will issue you an API Gateway Key for your integration.
\nA set of application credentials, similar to Basic Auth: Username & Password. They are typically are generated for a API rather than an individual user.
\nAuthentication to SambaSafety's REST API is performed via HTTP Bearer Auth. Provide your API key as the Bearer token key value.
\nYour credentials carry many privileges, so be sure to keep them secure! Do not share your secret API key in publicly access.
\n","_postman_id":"ec0a7031-0692-454b-b9f8-5236e8465845","auth":{"type":"apikey","apikey":{"key":"(Required) The unique identifier of the platform organization
\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"licenseState\": \"CO\",\n \"licenseNumber\": \"000000000\",\n \"birthDate\": \"1980-01-01\",\n \"firstName\": \"Mario\",\n \"lastName\": \"Luigi\",\n \"middleName\": \"K\",\n \"gender\": \"0\",\n \"ssn\": \"\",\n \"stateAccessCode\": \"\",\n \"billCode\": \"\",\n \"billReference\": \"sring\",\n \"productId\": \"DL\",\n \"subType\": \"STANDARD\",\n \"host\": \"ONLINE\",\n \"purpose\": \"EMPLOYMENT\",\n \"customFields\": [\n {\n \"name\": \"regions\",\n \"value\": \"northeast, northwest\"\n }\n ],\n \"reportFormats\": [\n \"application/vnd.sambasafety.platform.mvr+pdf\",\n \"application/vnd.sambasafety.platform.mvr+html\"\n ],\n \"yearsRequired\": \"3\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/organization/v1/licenses/history","description":"Place an order for a license history discovery report.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: application/json
X-Api-Key: [ApiKey]
Parameters:
\nproductId (string, required): The state product code. \"DL\" is the default value.
subType (string, required): The state's sub type of MVR. [\"3Y\", \"5Y\", \"7Y\", \"EM\", \"DB\", \"CR\"]
host (string, required): The method of ordering. [\"ONLINE\", \"OVERNIGHT\"]
purpose (string, required): The purpose for requesting the MVR. [\"EMPLOYEMENT\", \"INSURANCE\"]
licenseState (string, required): The state jurisdiction issuing the document, US State Abbreviation.
licenseNumber (string, required): The number of the document. License Number Patterns
birthDate (string, date, required): The person's date of birth. \"YYYY-MM-DD\"
lastName (string(40), required): The person's family name, as indicated on the document.
firstName (string(40), required): The person's given name, as indicated on the document.
middleName (string(20), optional): The person's middle name or initial, if indicated on the document.
gender (string, optional): The person's gender: [\"M, F, X\"]
ssn (string, optional): The person's social security number. [\"4\",\"9\"] digits without dashes.
billCode (string(100), optional): A customer's custom billing code.
billReference (string(250), optional): A customer's custom billing reference note.
stateAccessCode (string, optional): CA, PA, and UT require access codes.
reportFormats (string, options): The format of the report. Obsolete, use Accept Headers.
yearsRequired (string(2), required): The number of required years of confirmed driving history.
Upon successful request, the API will respond with the a 201 Created containing the order ID.
\norderId (string, uuid): The order's unique identifier.(Required) The unique identifier of the platform organization
\n"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/reports/v1/licensehistory/:orderId","description":"This endpoint retrieves summary information for the corresponding order ID. The request does not include a request body.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: application/json
X-Api-Key: [ApiKey]
Parameters:
\norderId the unique identifer for the order.Upon successful request, the API will respond with details for the corresponding order. Contains the orderStatus and a links reference to the report, when completed.
\nParameters:
\norderId (string, uuid): The order's unique identifier.
status (string): The status of the order.
orderDateTime (string, datetime): The timestamp of the order.
orderCompletedDateTime (string, datetime): The timestamp of the order was completed.
mvrsOrdered (array): An object containing a Link to an MVR Report if ordered.
rel (string): The relationship of the link.
href (string): The URL of the link.
type (string): The HTTP Method used to access the link.
id (string): The unique identifier associated with the link.
finding (string): The findings of the request.
result (object): The license object containing:
code (string): Order result code.
message (string): Order result message.
source (string): A SambaSafety source for the order.
historyDate (string, date): The source date of the data.
If you have subscribed to the webhook when the order has been successfully \"fulfilled\", the CallbackURL will be invoked with a \"POST\" and a body containing a url link to the report, and the report uuid.
\nlhdorder.receivedParameters:
\neventId (string, uuid): The callback event's unique identifier.
createdDateTime (string, date): The callback event's timestamp.
data (object): The order summary object containing:
orderId (string, uuid): The order's unique identifier.
orderDateTime (string, datetime): The timestamp of the order.
links (array): An array of links related to the order.
rel (string): The relationship of the link.
href (string): The URL of the link.
type (string): The HTTP Method used to access the link.
id (string): The unique identifier associated with the link.
eventType (string): The callback event name.
(Required) The order's unique identifier.
\n","type":"text/plain"},"type":"any","value":"","key":"orderId"}]}},"response":[{"id":"5a3bd6cf-fed2-4441-9d25-0a466a42606c","name":"200 OK CONFIRMED","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}","description":"(Required) The unique identifier of the platform organization"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerThe License History Discovery service interrogates SambaSafety’s proprietary datasets using the personal identifiers submitted to locate records that can verify license history. It fills the void where states do not provide the true license history for an individual. It can optimize workflows and speed up onboarding of drivers for companies.
\nAuthentication: Obtain a token to gain access
\nPlace an Order: Place an order to get data for the person
\nCheck Order Status: Check whether an order that has been placed has been fulfilled
\nFor more information on License History Discovery visit our SambaSafety Knowledge Base
\n","_postman_id":"21f5eba9-ec47-4e3f-8ede-094992c4da40","auth":{"type":"apikey","apikey":{"key":"(Required) The unique identifier of the platform organization
\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Trinity\",\n \"middleName\": \"Stephen\",\n \"lastName\": \"Johnson\",\n \"birthDate\": \"2022-09-15\",\n \"address\": {\n \"city\": \"Appleton\",\n \"state\": \"CA\",\n \"street\": \"221B Baker Street\",\n \"zipCode\": \"54915\"\n },\n \"billCode\": \"\",\n \"billReference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/orders/v1/licensenumbersearch","description":"Search for a drivers license number (DLN) in our database.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: application/json
X-Api-Key: [ApiKey]
Parameters:
\nbirthDate (string, date, required): The person's date of birth. \"YYYY-MM-DD\"
lastName (string(40), required): The person's family name, as indicated on the document.
firstName (string(40), required): The person's given name, as indicated on the document.
middleName (string(20), optional): The person's middle name or initial, if indicated on the document.
address (object, required): An address object containing:
street (string, required): The person's mailing street address.
city (string, required): The person's mailing municipality.
state (string(2), required): The person's mailing state, US State Abbreviation.
zipCode (string, required): The person's mailing postal code.
billCode (string(100), optional): A customer's custom billing code.
billReference (string(255), optional): A customer's custom billing reference note.
Upon successful request, the API will respond with the a 201 Created containing the order ID.
\norderId (string, uuid): The order's unique identifier.
licenseNumber(string): The full driver's license number.
licenseState (string): The license's issuing state.
licenseMask (string): A masked version of driver's license number.
status (string): A status for the result.
A successful response is broken down into three statuses.
\nSuccess containing the Full License Number and a Masked (last four digits) License Number.
\nMultiple Match if multiple potential licenses were detected for a requested driver.
\nNot Found if we can not locate a matching license in our database.
\nThe applicants driver’s license number is a challenging piece of information for insurance carriers to obtain today. Although an essential piece of information, the customer needs to be able to uncover driver history and enable real-time, accurate risk assessment at quote to reduce friction during application process.
\nAuthentication: Obtain a token to gain access
\nPerform a Search: Perform a search to get data for the person
\nFor more information on License Number Search visit our SambaSafety Knowledge Base
\n","_postman_id":"21fbfd31-b685-4636-b268-0216324fb46c","auth":{"type":"apikey","apikey":{"key":"(Required) The unique identifier of the platform organization
\n"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/orders/v1/licensereports/verifylicense?page=1&size=50&startOrderDate=2023-01-01&endOrderDate=2023-09-15","description":"This endpoint retrieves list of previouss orders placed for the Service. The request does not include a request body. Upon successful request, the API will respond with a list of previously placed orders, including the current order status.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: application/json
X-Api-Key: [ApiKey]
Parameters:
\npage:the page of transactions to review. Default value: 1
size:the number of transactions to review on a page. Default value:25
startOrderDate: Start date when orders were created. If value is not provided, search will default to midnight (00:00:00 a.m.) of previous day.
endOrderDate Inclusive end date when orders were created. If value is not provided, search will default to end of day (23:59:59 p.m.).
Parameters:
\ndata
errorMessage (string): An error message attached to the order.
orderId (string, uuid): The license's unique identifier.
status (string): The enrollment type.
request (object): The order request object from Place an Order.
createdDateTime (string, datetime): The timestamp of the order.
meta
totalPages (number): The total number of pages.
totalRecords (number): The total number of records.
links
self (string, url): The URL to the current page.
first (string, url): The URL to the first page of data.
next (string, url): The URL to the next page of data.
prev (string, url): The URL to the previous page of data.
last (string, url): The URL to the last page of data.
The page of data being displayed.
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"The number of items on a page.
\n","type":"text/plain"},"key":"size","value":"50"},{"description":{"content":"Start date when orders were created. If value is not provided, search will default to midnight (00:00:00 a.m.) of previous day.
\nPattern: yyyy-MM-dd
\n","type":"text/plain"},"key":"startOrderDate","value":"2023-01-01"},{"description":{"content":"Inclusive end date when orders were created. If value is not provided, search will default to end of day (23:59:59 p.m.).
\nPattern: yyyy-MM-dd
\n","type":"text/plain"},"key":"endOrderDate","value":"2023-09-15"}],"variable":[]}},"response":[{"id":"d24ceae3-35bf-46cc-945b-33929854c78d","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}","description":"(Required) The unique identifier of the platform organization"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer(Required) The unique identifier of the platform organization
\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"purpose\": \"INSURANCE\",\n \"licenseCategory\": \"LICENSE\",\n \"birthDate\": \"1980-01-01\",\n \"firstName\": \"Ponda\",\n \"lastName\": \"Midge\",\n \"licenseNumber\": \"9876006789\",\n \"licenseState\": \"IN\",\n \"middleName\": \"C\",\n \"suffix\": \"\",\n \"billCode\": \"\",\n \"billReference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/orders/v1/licensereports/verifylicense","description":"This endpoint creates a new order for an License Verification Report, for a single driver.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: application/json
X-Api-Key: [ApiKey]
Parameters:
\nlicenseCategory (string, required): The document's category, License Category.
licenseState (string, required): The state jurisdiction issuing the document, US State Abbreviation.
licenseNumber (string, required): The person's family name, as indicated on the document.
birthDate (string, date, required): The person's date of birth.
lastName (string, required): The person's family name, as indicated on the document.
firstName (string, required): The person's given name, as indicated on the document.
middleName (string, optional): The person's middle name or initial, if indicated on the document.
suffix (string, optional): The person's family suffix, Suffix.
address (object, optional): An address object containing:
street (string): The person's mailing street address.
city (string): The person's mailing municipality.
state (string): The person's mailing state, US State Abbreviation.
zipCode (string): The person's mailing postal code.
gender (string, optional): The person's gender, Gender.
height (number, optional): The person's height.
weight (number, optional): The person's weight.
eyeColor (string, optional): The person's eye-color, Eye-Color.
issueDate (string, date, optional): The document's issue date.
expiryDate (string, date, optional): The document's expiration date.
customFields (Array[object], optional): A customer's custom fields.
billCode (string, optional): A customer's custom billing code.
billReference (string, optional): A customer's custom billing reference note.
Upon successful request, the API will respond with the a 201 Created containing the order ID.
\nParameters:
\norderId (string, uuid): The order's unique identifier.(Required) The unique identifier of the platform organization
\n"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/orders/v1/licensereports/verifylicense/:orderId","description":"This endpoint retrieves summary information for the corresponding order ID. The request does not include a request body.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: application/json
X-Api-Key: [ApiKey]
Parameters:
\norderId the unique identifer for the order.Upon successful request, the API will respond with details for the corresponding order. Contains the orderStatus and a links reference to the report, when completed.
\nParameters:
\norderId (string, uuid): The order's unique identifier.
orderStatus (string): The status of the order.
orderDateTime (string, datetime): The timestamp of the order.
orderCompletedDateTime (string, datetime): The timestamp of the order was completed.
controlNumber (string): A SambaSafety identifier for the order.
links (object): An array of links related to the order.
rel (string): The relationship of the link.
href (string): The URL of the link.
type (string): The HTTP Method used to access the link.
id (string): The unique identifier associated with the link.
If you have subscribed to the webhook when the order has been successfully \"fulfilled\", the CallbackURL will be invoked with a \"POST\" and a body containing a url link to the report, and the report uuid.
\nIf an error occurs, the response will have an “error\" event type, with a description of the error.
\nlicensevalidation.received
licensevalidation.error
Parameters:
\neventId (string, uuid): The callback event's unique identifier.
data (object): The order summary object containing:
orderId (string, uuid): The order's unique identifier.
links (array): An array of links related to the order.
rel (string): The relationship of the link.
href (string): The URL of the link.
type (string): The HTTP Method used to access the link.
id (string): The unique identifier associated with the link.
orderDate (string, datetime): The timestamp of the order.
productOrdered (string): The product ordered (subType).
createdDateTime (string, date): The callback event's timestamp.-
eventType (string): The callback event name.
(Required) The order's unique identifier.
\n","type":"text/plain"},"type":"any","value":"","key":"orderId"}]}},"response":[{"id":"7fab90d7-8ecc-4928-9e17-b1b5edd20ba8","name":"200 OK: Status: Fulfilled","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}","description":"(Required) The unique identifier of the platform organization"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer(Required) The unique identifier of the platform organization
\n"},{"key":"Accept","value":"application/vnd.sambasafety.json;version=2.0.4"}],"url":"{{baseUrl}}/reports/v1/licensereports/verifylicense/:reportId","description":"This endpoint retrieves License Verification Report for the corresponding Report ID.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: [Document Version]
X-Api-Key: [ApiKey]
Available Versions:
\napplication/vnd.sambasafety.json;version=2.0.4
\napplication/vnd.sambasafety.xml;version=2.0.3
\napplication/vnd.sambasafety.xml;version=2.0.2
\napplication/vnd.sambasafety.xml;version=2.0.0
\napplication/vnd.sambasafety.html
\napplication/vnd.sambasafety.pdf ( Base64 Encoded String )
\nParameters:
\nreportId: the unique identifer for the License Verification Report.Upon successful request, the API will respond with the License Discovery Report for the reportId and report version requested.
Parameters:
\nRecord
DlRecord
Criteria(object): Contains parameters sent with the request.
OrderDate(object): Contains the date parameters of when the order was placed.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
OrderTime(object): Contains the time parameters of when the order was placed.
Hour(string): The time's hour component [0-23].
Minute(string): The time's minute component [0-59].
Second(string): The time's second component [0-59].
AccountID(string): The account the order was placed under.
UserID(string): The account user who placed the order.
Routing(string): An internal system routing id.
TrackingNumber(string): An internal system tracking number.
Host(string): The internal service identifier.
ProductID(string): The internal product code for the order.
State(object): The license state provided in the request.
Abbrev(string): The state's abbreviation.
Full(string): The state's full name.
Subtype(string): A code indicating a product subtype.
SubtypeFull(string): The full name for the product subtype.
FirstName(string): The first name provided in the request.
LastName(string): The last name provided in the request.
BirthDate(string): The birth date provided in the request.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
Result(object): Contains the results of the order.
Control(string): An internal control number for the order.
Valid(string): A [Y,N] indicator that the order was valid.
ErrorCode(string): A code for associated with an error.
ErrorDescription(string): A message describing the result.
ReturnedDate(object): Contains the date parameters of when the order was returned.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ReturnTime(object): Contains the time parameters of when the order was returned.
Hour(string): The time's hour component [0-23].
Minute(string): The time's minute component [0-59].
Second(string): The time's second component [0-59].
ResultCode(string): A code for the result.
LicenseValidation(object): An object representing the license validation results.
DocumentValidationResult(string): A [PASS/FAIL] indicator on the overall document validation.
MatchError(string): A field name that had a match error.
DriverLicenseNumberMatch(string): A [TRUE/FALSE] indicator if license numbers match.
BirthDateMatch(string): A [TRUE/FALSE] indicator if birth dates match.
LastNameExactMatch(string): A [TRUE/FALSE] indicator if last name exactly matches.
LastNameFuzzyPrimMatch(string): A [TRUE/FALSE] indicator if last name fuzzy matches.
LastNameFuzzyAltMatch(string): A [TRUE/FALSE] indicator if last name fuzzy matches.
FirstNameExactMatch(string): A [TRUE/FALSE] indicator if first name exactly matches.
FirstNameFuzzyPrimMatch(string): A [TRUE/FALSE] indicator if first name fuzzy matches.
FirstNameFuzzyAltMatch(string): A [TRUE/FALSE] indicator if first name fuzzy matches.
MiddleNameExactMatch(string): A [TRUE/FALSE] indicator if middle name exactly matches.
MiddleNameFuzzyPrimMatch(string): A [TRUE/FALSE] indicator if middle name fuzzy matches.
MiddleNameFuzzyAltMatch(string): A [TRUE/FALSE] indicator if middle name fuzzy matches.
MiddleNameInitialMatch(string): A [TRUE/FALSE] indicator if middle initial exactly matches.
NameSufixMatch(string): A [TRUE/FALSE] indicator if suffix exactly matches.
DocumentCategoryMatch(string): A [TRUE/FALSE] indicator if document category matches.
IssueDateMatch(string): A [TRUE/FALSE] indicator if issue date matches.
ExpiryDateMatch(string): A [TRUE/FALSE] indicator if expiration date matches.
SexMatch(string): A [TRUE/FALSE] indicator if gender matches.
HeightMatch(string): A [TRUE/FALSE] indicator if height matches.
WeightMatch(string): A [TRUE/FALSE] indicator if weight matches.
EyeColorMatch(string): A [TRUE/FALSE] indicator if eye color matches.
Address1Match(string): A [TRUE/FALSE] indicator if address line 1 matches.
Address2Match(string): A [TRUE/FALSE] indicator if address line 2 matches.
AddressCityMatch(string): A [TRUE/FALSE] indicator if address city matches.
AddressStateMatch(string): A [TRUE/FALSE] indicator if address state matches.
AddressZip5Match(string): A [TRUE/FALSE] indicator if address zipcode first 5 digits match.
AddressZip4Match(string): A [TRUE/FALSE] indicator if address zipcode last 4 digits match.
Driver(object): An object representing the driver.
FirstName(string): The first name of the driver.
MiddleName(string): The middle name of the driver.
LastName(string): The last name of the driver.
SuffixName(string): The suffix name of the driver.
CurrentLicense(object): A report object that contains a drivers active licenses.
Number(string): The current license number.(Required) A report's unique identifier.
\n","type":"text/plain"},"type":"any","value":"","key":"reportId"}]}},"response":[{"id":"58bc12ae-7f1e-4e10-8e6c-9e5c86dd8b24","name":"200 OK: Validation Pass","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}","description":"(Required) The unique identifier of the platform organization"},{"key":"Accept","value":"application/vnd.sambasafety.json;version=2.0.4"},{"key":"Authorization","value":"BearerThe License Validation service validates the license details for a person by determining if the information provided by the driver matches with information maintained at the Department of Motor Vehicles (State Jurisdiction).
\nAuthentication: Obtain a token to gain access
\nPlace an Order: Place an order to get data for the person
\nCheck Order Status: Check whether an order that has been placed has been fulfilled
\nGet Order Report: Get the data ordered
\nFor more information on License Verification visit our SambaSafety Knowledge Base
\n","_postman_id":"81db1cc2-1d48-4c5a-b70d-e2c278a402a7","auth":{"type":"apikey","apikey":{"key":"This endpoint creates a new order for an Activity Indicator Report, for a single driver.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: all content type symbol
X-Api-Key: [ApiKey]
Parameters:
\nlicenseState (string(2), required): The state jurisdiction issuing the document, US State Abbreviation.
licenseNumber (string, required): The number of the document. License Number Patterns
birthDate (string, date, required): The person's date of birth. \"YYYY-MM-DD\"
lastName (string(40), required): The person's family name, as indicated on the document.
firstName (string(40), required): The person's given name, as indicated on the document.
middleName (string(20), optional): The person's middle name or initial, if indicated on the document.
address (object, optional): An object containing the person's address as on the license:
street (string): The person's mailing street address.
city (string): The person's mailing municipality.
state (string(2)): The person's mailing state, US State Abbreviation.
zipCode (string): The person's mailing postal code.
billCode (string(100), optional): A customer's custom billing code - passes to billing details
billReference (string,(250) optional): A customer's custom billing reference note - passes to billing details
searchStartDatesearchStartDate (string, date, required) The day the search starts \"YYYY-MM-DD\"
The response for this request is a JSON schema:
\n{\n \"orderId\": \"a9effbb3-4178-f6e9-08a7-e9520c4620d7\"\n}\n\nThis endpoint retrieves summary information for the corresponding order ID. The request does not include a request body.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: all content type symbol
X-Api-Key: [ApiKey]
Parameters:
\norderId the unique identifer for the order.Upon successful request, the API will respond with details for the corresponding order. Contains the orderStatus and a links reference to the report, when completed.
\nParameters:
\norderId (string, uuid): The order's unique identifier.
orderStatus (string): The status of the order.
orderDateTime (string, datetime): The timestamp of the order.
links (object): An array of links related to the order.
rel (string): The relationship of the link.
href (string): The URL of the link.
type (string): The HTTP Method used to access the link.
id (string): The unique identifier associated with the link.
If you have subscribed to the webhook when the order has been successfully \"fulfilled\", the CallbackURL will be invoked with a \"POST\" and a body containing a url link to the report, and the report uuid.
\nIf an error occurs, the response will have an “error\" event type, with a description of the error.
\nactivityindicator.receivedParameters:
\neventId (string, uuid): The callback event's unique identifier.
data (object): The order summary object containing:
orderId (string, uuid): The order's unique identifier.
orderDateTime (string, datetime): The timestamp of the order.
links (array): An array of links related to the order.
rel (string): The relationship of the link.
href (string): The URL of the link.
type (string): The HTTP Method used to access the link.
id (string): The unique identifier associated with the link.
createdDateTime (string, date): The callback event's timestamp.-
eventType (string): The callback event name.
This endpoint retrieves Activity Indicator Report for the corresponding Report ID.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: any content symbol
X-Api-Key: [ApiKey]
Available Versions:
\nParameters:
\nreportId: the unique identifier for the report.Upon successful request, the API will respond with the Activity Indicator Report for the reportId and report version requested.
Parameters
\nreportId (string, uuid): The report's unique identifier.
reportDateTime (string, datetime): The report's timestamp when it was completed.
reportOrder (object): The order's request body.
reportOrderResult (object): The result of the order.
activityFound(string): The result of the search (YES, NO, UNKNOWN)
actualSearchStartDate (string, date): The report's search start date.
asofDate (string, date): activityFound as of this date
The Activity Indicator service interrogates SambaSafety’s proprietary datasets using the personal identifiers submitted to locate records that can identify traffic violation activity.
\nAuthentication: Obtain a token to gain access
\nPlace an Order: Place an order to get data for the person
\nCheck Order Status: Check whether an order that has been placed has been fulfilled
\nGet a Report: Get the data ordered
\nFor more information on Activity Indicator visit our SambaSafety Knowledge Base
\n","_postman_id":"a8d31818-8eb9-4564-b23a-c7521f6aa89a","auth":{"type":"apikey","apikey":{"key":"(Required) The unique identifier of the platform organization
\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"searchStartDate\": \"2019-10-29\",\n \"licenseState\": \"NJ\",\n \"licenseNumber\": \"J22002020401301\",\n \"birthDate\": \"1974-01-29\",\n \"lastName\": \"Public\",\n \"middleName\": \"Q\",\n \"firstName\": \"John\",\n \"address\": {\n \"street\": \"123 Main Street, Apt 101\",\n \"city\": \"Paramus\",\n \"state\": \"NJ\",\n \"zipCode\": 7666\n },\n \"billCode\": \"Demo\",\n \"billReference\": \"Account\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/orders/v1/activityreports/history","description":"This endpoint creates a new order for an Activity History Report, for a single driver.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: application/json
X-Api-Key: [ApiKey]
Parameters:
\nlicenseState (string(2), required): The state jurisdiction issuing the document, US State Abbreviation.
licenseNumber (string, required): The number of the document. License Number Patterns
birthDate (string, date, required): The person's date of birth. \"YYYY-MM-DD\"
lastName (string(40), required): The person's family name, as indicated on the document.
firstName (string(40), required): The person's given name, as indicated on the document.
middleName (string(20), optional): The person's middle name or initial, if indicated on the document.
address (object, optional): An object containing the person's address as on the license:
street (string): The person's mailing street address.
city (string): The person's mailing municipality.
state (string(2)): The person's mailing state, US State Abbreviation.
zipCode (string): The person's mailing postal code.
billCode (string(100), optional): A customer's custom billing code.
billReference (string,(250) optional): A customer's custom billing reference note.
searchStartDatesearchStartDate (string, date, required) The day the search starts \"YYYY-MM-DD\"
Upon successful request, the API will respond with the a 201 Created containing the order ID.
\nParameters:
\norderId (string, uuid): The order's unique identifier.(Required) The unique identifier of the platform organization
\n"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/orders/v1/activityreports/history/:orderId","description":"This endpoint retrieves summary information for the corresponding order ID. The request does not include a request body.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: application/json
X-Api-Key: [ApiKey]
Parameters:
\norderId the unique identifer for the order.Upon successful request, the API will respond with details for the corresponding order. Contains the orderStatus and a links reference to the report, when completed.
\nParameters:
\norderId (string, uuid): The order's unique identifier.
orderStatus (string): The status of the order.
orderDateTime (string, datetime): The timestamp of the order.
links (object): An array of links related to the order.
rel (string): The relationship of the link.
href (string): The URL of the link.
type (string): The HTTP Method used to access the link.
id (string): The unique identifier associated with the link.
If you have subscribed to the webhook when the order has been successfully \"fulfilled\", the CallbackURL will be invoked with a \"POST\" and a body containing a url link to the report, and the report uuid.
\nIf an error occurs, the response will have an “error\" event type, with a description of the error.
\nactivityhistory.receivedParameters:
\neventId (string, uuid): The callback event's unique identifier.
data (object): The order summary object containing:
orderId (string, uuid): The order's unique identifier.
orderDateTime (string, datetime): The timestamp of the order.
links (array): An array of links related to the order.
rel (string): The relationship of the link.
href (string): The URL of the link.
type (string): The HTTP Method used to access the link.
id (string): The unique identifier associated with the link.
createdDateTime (string, date): The callback event's timestamp.-
eventType (string): The callback event name.
(Required) The order's unique identifier.
\n","type":"text/plain"},"type":"any","value":"","key":"orderId"}]}},"response":[{"id":"8c6b44bb-4ffe-42dd-bc41-bd0dfd26e372","name":"200 OK: Status: Fulfilled","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}","description":"(Required) The unique identifier of the platform organization"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer(Required) The unique identifier of the platform organization
\n"},{"key":"Accept","value":"application/vnd.sambasafety.activityhistory+json;version=2.0.0"}],"url":"{{baseUrl}}/reports/v1/activityreports/history/:reportId","description":"This endpoint retrieves Activity History Report for the corresponding Report ID.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: [Document Version]
X-Api-Key: [ApiKey]
Available Versions:
\napplication/vnd.sambasafety.activityhistory+json;version=1.0.0 (court records only)
\napplication/vnd.sambasafety.activityhistory+json;version=2.0.0
\napplication/vnd.sambasafety.activityhistory+html;version=1.0.0 (court records only)
\napplication/vnd.sambasafety.activityhistory+html;version=2.0.0
\nParameters:
\nreportId: the unique identifier for the report.Upon successful request, the API will respond with the Activity History Report for the reportId and report version requested.
Parameters:
\nreportId (string, uuid): The report's unique identifier.
reportDateTime (string, datetime): The report's timestamp when it was completed.
reportOrder (object): The order's request body.
reportOrderResult (object): The result of the order.
actualSearchStartDate (string, date): The report's search start date.
publicRecordDate (string, date): The report's public record date.
courtRecord (object): A court recorded returned for the order.
violations (array): A court recorded returned for the order
state (string): The state jurisdiction of the violation.
date (string, date): The date of the violation.
location (string): The location of the violation.
docketNumber (string): The court docket number of the violation.
actualSpeed (string): The ticket's actual speed recorded.
postedSpeed (string): The ticket's posted speed limit.
statute (string): The state's statute associated with the violation.
courtType (string): The court type adjudicating the violation.
disposition (string): The court's disposition of the violation.
plea (string): The person's entered plea.
sentencing (string): The court's sentencing.
dispositionDate (string, date): The date of the court's disposition.
reportedDmv (string): The violation is reported to the DMV.
reportedDmvDate (string, date): The date the violation was reported to the DMV.
message (string): A message associated with the violation.
person (object):The person associated with the violation.
licenseState (string): The state issuing the license.
licenseNumber (string): The number of the document.
birthDate (string, date): The person's date of birth.
lastName (string): The person's family name, as indicated on the document.
firstName (string): The person's given name, as indicated on the document.
middleName (string): The person's middle name or initial, if indicated on the document.
suffix (string): The person's family suffix, Suffix.
address (object): An address object containing:
street (string): The person's mailing street address.
city (string): The person's mailing municipality.
state (string): The person's mailing state.
zipCode (string): The person's mailing postal code.
infractions (array): The infractions associated with the violation.
description (string): The normalized description of the infraction.
stateDescription (string): The state description of the infraction.
stateCode (string): The infraction's jurisdiction.
acd (string):
avd2 (string):
avd3 (string):
publicRecord (object): A court recorded returned for the order.
person (object): The person of the public record.
licenseState (string): The state issuing the license.
licenseNumber (string): The number on the license.
birthDate (string, date): The person's date of birth.
lastName (string): The person's family name, as indicated on the document.
firstName (string): The person's given name, as indicated on the document.
middleName (string): The person's middle name or initial, if indicated on the document.
suffix (string): The person's family suffix.
age (number): The age of the person.
gender (string): The gender of the person.
eyeColor (string): The eye-color of the person.
hairColor (string): The hair-color of the person.
height (string): The height of the person.
weight (string): The weight of the person.
deceased (boolean): Indicates the person is deceased.
cdl (string): Indicates a commercial drivers license.
violations (array): A list of public record violations.
state (string): The state jurisdiction of the violation.
date (string, date): The date of the violation.
location (string): The location of the violation.
docketNumber (string): The court docket number of the violation.
actualSpeed (string): The ticket's actual speed recorded.
postedSpeed (string): The ticket's posted speed limit.
statute (string): The state's statute associated with the violation.
courtType (string): The court type adjudicating the violation.
disposition (string): The court's disposition of the violation.
postedDate (string, date): The posted date of the violation.
modifiedDate (string, date): Modified date, if updated.
isHazMat (string): The court type adjudicating the violation.
isCommercial (string): The court type adjudicating the violation.
convictionDate (string, date): A conviction date associated with the violation.
dismissalCode (string): A dismissal code associated with the violation.
dismissalDate (string, date): A dismissal date associated with the violation.
bloodAlcoholLevel (string): A blood-alcohol-level associated with the violation.
plate (string): A license plate associated with the violation.
amendedConsentDate (string, date): An amended consent date associated with the violation.
consentDate (string, date): A consent date associated with the violation.
hasFailureToPayFine (string): A failure to pay fine associated with the violation.
fineAmount (string): A fine associated with the violation.
judgeName (string): The judge associated with the violation.
isAssociatedWithSuspension (string): A suspension is associated with the violation.
isAssociatedWithAccident (string): An accident is associated with the violation.
hasAccidentInjury (string): An injury is associated with the accident.
hasAccidentFatality (string): A fatality is associated with the accident.
stateAdditional (string): Additional state messages associated with the violation.
infractions (array): The infractions associated with the violation.
description (string): The normalized description of the infraction.
stateDescription (string): The state description of the infraction.
stateCode (string): The infraction's jurisdiction.
acd (string):
avd1 (string):
avd2 (string):
avd3 (string):
companyCode (string): A company code for scoring.
companyPoints (string): The company assigned points for scoring.
tableKey (string): An internal reference.
stateAssignedPoints (string): The state points associated with the infraction.
accidents (array): A list of public record accidents.
state (string): The state jurisdiction of the accident, US State Abbreviation.
date (string, date): The date of the accident.
postedDate (string, date): The posted date of the accident.
modifiedDate (string, date): Modified date, if updated.
location (string): The location of the accident.
locationCode (string): The location of the accident.
isHazMat (string): The court type adjudicating the accident.
isCommercial (string): The court type adjudicating the accident.
plate (string): A license plate associated with the accident.
isInjuryAccident (string): An injury is associated with the accident.
isAtFault (string): An at-fault is associated with the accident.
isFatalityAccident (string): A fatality is associated with the accident.
frPolicyNumber (string): A financial resp. associated with the accident.
isReportFiled (string): A report is filed with the accident.
reportNumber (string): The report number for the accident.
frFileNumber (string): A financial resp. file number for the accident.
accidentFatalityCount (string): A number of fatalities in the accident.
accidentInjuryCount (string): A number of injured in the accident.
stateAdditional (string): Additional state messages associated with the accident.
infractions (array): The infractions associated with the violation.
description (string): The normalized description of the infraction.
stateDescription (string): The state description of the infraction.
stateCode (string): The infraction's jurisdiction.
acd (string):
avd1 (string):
avd2 (string):
avd3 (string):
companyCode (string): A company code for scoring.
companyPoints (string): The company assigned points for scoring.
tableKey (string): An internal reference.
stateAssignedPoints (string): The state points associated with the infraction.
actions (array): A list of public record actions.
state (string): The state jurisdiction of the action, US State Abbreviation.
date (string, date): The date of the action.
postedDate (string, date): The posted date of the action.
modifiedDate (string, date): Modified date, if updated.
location (string): The location of the action.
locationCode (string): The location of the action.
isHazMat (string): The court type adjudicating the action.
isCommercial (string): The court type adjudicating the action.
docketNumber (string): The docket number associated with the action.
privilegeReinstatementDate (string, date): A privilege reinstatement date associated with the action.
actualDate (string, date): The actual date of the action.
clearDate (string, date): A cleared date associated with the action.
actionEndDate (string, date): An action end date associated with the action.
arrestDate (string, date): An arrest date associated with the action.
mailDate (string, date): A mail date associated with the action.
offenseDate (string, date): An offense date associated with the action.
extent (string): An extent detail associated with the action.
judgeName (string): The judge associated with the action.
lengthInMonths (string): The number of months for the action.
additionalDescription (string): An addition description associated with the action.
currentStatus (string): The current status associated with the action.
stateAdditional (string): Additional state messages associated with the action.
infractions (array): The infractions associated with the violation.
description (string): The normalized description of the infraction.
stateDescription (string): The state description of the infraction.
stateCode (string): The infraction's jurisdiction.
acd (string):
avd1 (string):
avd2 (string):
avd3 (string):
companyCode (string): A company code for scoring.
companyPoints (string): The company assigned points for scoring.
tableKey (string): An internal reference.
stateAssignedPoints (string): The state points associated with the infraction.
adjudicatedAndWithdrawals (array): A list of public record adjudications.
state (string): The state jurisdiction of the adjudication.
date (string, date): The date of the adjudication.
postedDate (string, date): The posted date of the adjudication.
modifiedDate (string, date): Modified date, if updated.
location (string): The location of the accident.
locationCode (string): The location of the accident.
docketNumber (string): The docket number associated with the adjudication.
isAssociatedWithAccident (string): An accident is associated with the adjudication.
convictionDate (string, date): The conviction date of the adjudication.
courtType (string): The court type adjudicating the violation.
disposition (string): The court's disposition of the violation.
actualSpeed (string): The ticket's actual speed recorded.
postedSpeed (string): The ticket's posted speed limit.
descriptionList (array): The infractions associated with the violation.
description (string): The normalized description of the infraction.
stateDescription (string): The state description of the infraction.
stateCode (string): The infraction's jurisdiction.
acd (string):
avd1 (string):
avd2 (string):
avd3 (string):
companyCode (string): A company code for scoring.
companyPoints (string): The company assigned points for scoring.
tableKey (string): An internal reference.
stateAssignedPoints (string): The state points associated with the infraction.
failureToAppear (array): A list of public record failure to appears.
state (string): The state jurisdiction of the FTA.
date (string, date): The date of the FTA.
postedDate (string, date): The posted date of the FTA.
location (string): The location of the FTA.
locationCode (string): The location of the FTA.
docketNumber (string): The docket number associated with the FTA.
plate (string): A license plate associated with the FTA.
bloodAlcoholLevel (string): A blood-alcohol-level associated with the FTA.
judgeName (string): The judge associated with the FTA.
isWarrantIssued (string): A warrant is issued for the FTA.
stateAdditional (string): Additional state messages associated with the action.
descriptionList (array): The infractions associated with the violation.
description (string): The normalized description of the infraction.
stateDescription (string): The state description of the infraction.
stateCode (string): The infraction's jurisdiction.
acd (string):
avd1 (string):
avd2 (string):
avd3 (string):
companyCode (string): A company code for scoring.
companyPoints (string): The company assigned points for scoring.
tableKey (string): An internal reference.
stateAssignedPoints (string): The state points associated with the infraction.
licenseClasses (object): The license class for the current license.
commercial (object, oneOf): A commercial driver's license.
license (object): Return for a license type.
classDescription (string): The class description of the license.
classCode (string): The class code of the license.
issueDate (string, date): The issue date of the license.
expirationDate (string, date): The expiration date of the license.
cdlMedicalExpirationDate (string, date): The expiration date of the Medical Certificate.
cdlMedicalType (string): The type of Medical Certificate associated with the license.
mailDate (string, date): A mail date associated with the license.
militaryExtension (string): A military extension is associated with the license.
hasDriverTraining (string): Driver training is associated with the license.
renewalDate (string, date): The renewal date the license.
srFileType (string): The SR-Filling type of the license.
statusList (array): The license status.
name (string): The license status name.
description (string): The license status name.
endorsements (array): A list of endorsements associated with the license.
description (string): The endorsement name.
endDate (string, date): The end date of the endorsement.
startDate (string, date): The start date of the endorsement.
restrictions (array): A list of restrictions associated with the license.
description (string): The restriction name.
endDate (string, date): The end date of the restriction.
startDate (string, date): The start date of the restriction.
certificates (array): A list of certificates associated with the license.
description (string): The certificate name.
startDate (string, date): The start date of the certificate.
permit(object): Returned for a permit type.
classDescription (string): The class description of the license.
classCode (string): The class code of the license.
issueDate (string, date): The issue date of the license.
expirationDate (string, date): The expiration date of the license.
cdlMedicalExpirationDate (string, date): The expiration date of the Medical Certificate.
cdlMedicalType (string): The type of Medical Certificate associated with the license.
mailDate (string, date): A mail date associated with the license.
militaryExtension (string): A military extension is associated with the license.
hasDriverTraining (string): Driver training is associated with the license.
renewalDate (string, date): The renewal date the license.
srFileType (string): The SR-Filling type of the license.
statusList (array): The license status.
name (string): The license status name.
description (string): The license status name.
endorsements (array): A list of endorsements associated with the license.
description (string): The endorsement name.
endDate (string, date): The end date of the endorsement.
startDate (string, date): The start date of the endorsement.
restrictions (array): A list of restrictions associated with the license.
description (string): The restriction name.
endDate (string, date): The end date of the restriction.
startDate (string, date): The start date of the restriction.
certificates (array): A list of certificates associated with the license.
description (string): The certificate name.
startDate (string, date): The start date of the certificate.
personal (object, oneOf): A personal driver's license.
license (object): Return for a license type.
classDescription (string): The class description of the license.
classCode (string): The class code of the license.
issueDate (string, date): The issue date of the license.
expirationDate (string, date): The expiration date of the license.
mailDate (string, date): A mail date associated with the license.
militaryExtension (string): A military extension is associated with the license.
hasDriverTraining (string): Driver training is associated with the license.
renewalDate (string, date): The renewal date the license.
srFileType (string): The SR-Filling type of the license.
statusList (array): The license status.
name (string): The license status name.
description (string): The license status name.
endorsements (array): A list of endorsements associated with the license.
description (string): The endorsement name.
endDate (string, date): The end date of the endorsement.
startDate (string, date): The start date of the endorsement.
restrictions (array): A list of restrictions associated with the license.
description (string): The restriction name.
endDate (string, date): The end date of the restriction.
startDate (string, date): The start date of the restriction.
certificates (array): A list of certificates associated with the license.
description (string): The certificate name.
startDate (string, date): The start date of the certificate.
permit(object): Returned for a permit type.
classDescription (string): The class description of the license.
classCode (string): The class code of the license.
issueDate (string, date): The issue date of the license.
expirationDate (string, date): The expiration date of the license.
mailDate (string, date): A mail date associated with the license.
militaryExtension (string): A military extension is associated with the license.
hasDriverTraining (string): Driver training is associated with the license.
renewalDate (string, date): The renewal date the license.
srFileType (string): The SR-Filling type of the license.
statusList (array): The license status.
name (string): The license status name.
description (string): The license status name.
endorsements (array): A list of endorsements associated with the license.
description (string): The endorsement name.
endDate (string, date): The end date of the endorsement.
startDate (string, date): The start date of the endorsement.
restrictions (array): A list of restrictions associated with the license.
description (string): The restriction name.
endDate (string, date): The end date of the restriction.
startDate (string, date): The start date of the restriction.
certificates (array): A list of certificates associated with the license.
description (string): The certificate name.
startDate (string, date): The start date of the certificate.
identification (object): A personal drivers license.
license (object): Return for a license type.
classDescription (string): The class description of the license.
classCode (string): The class code of the license.
issueDate (string, date): The issue date of the license.
expirationDate (string, date): The expiration date of the license.
mailDate (string, date): A mail date associated with the license.
militaryExtension (string): A military extension is associated with the license.
hasDriverTraining (string): Driver training is associated with the license.
renewalDate (string, date): The renewal date the license.
srFileType (string): The SR-Filling type of the license.
statusList (array): The license status.
name (string): The license status name.
description (string): The license status name.
endorsements (array): A list of endorsements associated with the license.
description (string): The endorsement name.
endDate (string, date): The end date of the endorsement.
startDate (string, date): The start date of the endorsement.
restrictions (array): A list of restrictions associated with the license.
description (string): The restriction name.
endDate (string, date): The end date of the restriction.
startDate (string, date): The start date of the restriction.
certificates (array): A list of certificates associated with the license.
description (string): The certificate name.
startDate (string, date): The start date of the certificate.
motorcycle (object, oneOf): A motorcycle driver's license.
license (object): Return for a license type.
classDescription (string): The class description of the license.
classCode (string): The class code of the license.
issueDate (string, date): The issue date of the license.
expirationDate (string, date): The expiration date of the license.
mailDate (string, date): A mail date associated with the license.
militaryExtension (string): A military extension is associated with the license.
hasDriverTraining (string): Driver training is associated with the license.
renewalDate (string, date): The renewal date the license.
srFileType (string): The SR-Filling type of the license.
statusList (array): The license status.
name (string): The license status name.
description (string): The license status name.
endorsements (array): A list of endorsements associated with the license.
description (string): The endorsement name.
endDate (string, date): The end date of the endorsement.
startDate (string, date): The start date of the endorsement.
restrictions (array): A list of restrictions associated with the license.
description (string): The restriction name.
endDate (string, date): The end date of the restriction.
startDate (string, date): The start date of the restriction.
certificates (array): A list of certificates associated with the license.
description (string): The certificate name.
startDate (string, date): The start date of the certificate.
permit(object): Returned for a permit type.
classDescription (string): The class description of the license.
classCode (string): The class code of the license.
issueDate (string, date): The issue date of the license.
expirationDate (string, date): The expiration date of the license.
mailDate (string, date): A mail date associated with the license.
militaryExtension (string): A military extension is associated with the license.
hasDriverTraining (string): Driver training is associated with the license.
renewalDate (string, date): The renewal date the license.
srFileType (string): The SR-Filling type of the license.
statusList (array): The license status.
name (string): The license status name.
description (string): The license status name.
endorsements (array): A list of endorsements associated with the license.
description (string): The endorsement name.
endDate (string, date): The end date of the endorsement.
startDate (string, date): The start date of the endorsement.
restrictions (array): A list of restrictions associated with the license.
description (string): The restriction name.
endDate (string, date): The end date of the restriction.
startDate (string, date): The start date of the restriction.
certificates (array): A list of certificates associated with the license.
description (string): The certificate name.
startDate (string, date): The start date of the certificate.
licenseClassHistory (array): The license class history for the person.
commercial (object, oneOf): A commercial driver's license.
license (object): Return for a license type.
classDescription (string): The class description of the license.
classCode (string): The class code of the license.
issueDate (string, date): The issue date of the license.
expirationDate (string, date): The expiration date of the license.
cdlMedicalExpirationDate (string, date): The expiration date of the Medical Certificate.
cdlMedicalType (string): The type of Medical Certificate associated with the license.
mailDate (string, date): A mail date associated with the license.
militaryExtension (string): A military extension is associated with the license.
hasDriverTraining (string): Driver training is associated with the license.
renewalDate (string, date): The renewal date the license.
srFileType (string): The SR-Filling type of the license.
statusList (array): The license status.
name (string): The license status name.
description (string): The license status name.
endorsements (array): A list of endorsements associated with the license.
description (string): The endorsement name.
endDate (string, date): The end date of the endorsement.
startDate (string, date): The start date of the endorsement.
restrictions (array): A list of restrictions associated with the license.
description (string): The restriction name.
endDate (string, date): The end date of the restriction.
startDate (string, date): The start date of the restriction.
certificates (array): A list of certificates associated with the license.
description (string): The certificate name.
startDate (string, date): The start date of the certificate.
permit(object): Returned for a permit type.
classDescription (string): The class description of the license.
classCode (string): The class code of the license.
issueDate (string, date): The issue date of the license.
expirationDate (string, date): The expiration date of the license.
cdlMedicalExpirationDate (string, date): The expiration date of the Medical Certificate.
cdlMedicalType (string): The type of Medical Certificate associated with the license.
mailDate (string, date): A mail date associated with the license.
militaryExtension (string): A military extension is associated with the license.
hasDriverTraining (string): Driver training is associated with the license.
renewalDate (string, date): The renewal date the license.
srFileType (string): The SR-Filling type of the license.
statusList (array): The license status.
name (string): The license status name.
description (string): The license status name.
endorsements (array): A list of endorsements associated with the license.
description (string): The endorsement name.
endDate (string, date): The end date of the endorsement.
startDate (string, date): The start date of the endorsement.
restrictions (array): A list of restrictions associated with the license.
description (string): The restriction name.
endDate (string, date): The end date of the restriction.
startDate (string, date): The start date of the restriction.
certificates (array): A list of certificates associated with the license.
description (string): The certificate name.
startDate (string, date): The start date of the certificate.
personal (object, oneOf): A personal driver's license.
license (object): Return for a license type.
classDescription (string): The class description of the license.
classCode (string): The class code of the license.
issueDate (string, date): The issue date of the license.
expirationDate (string, date): The expiration date of the license.
mailDate (string, date): A mail date associated with the license.
militaryExtension (string): A military extension is associated with the license.
hasDriverTraining (string): Driver training is associated with the license.
renewalDate (string, date): The renewal date the license.
srFileType (string): The SR-Filling type of the license.
statusList (array): The license status.
name (string): The license status name.
description (string): The license status name.
endorsements (array): A list of endorsements associated with the license.
description (string): The endorsement name.
endDate (string, date): The end date of the endorsement.
startDate (string, date): The start date of the endorsement.
restrictions (array): A list of restrictions associated with the license.
description (string): The restriction name.
endDate (string, date): The end date of the restriction.
startDate (string, date): The start date of the restriction.
certificates (array): A list of certificates associated with the license.
description (string): The certificate name.
startDate (string, date): The start date of the certificate.
permit(object): Returned for a permit type.
classDescription (string): The class description of the license.
classCode (string): The class code of the license.
issueDate (string, date): The issue date of the license.
expirationDate (string, date): The expiration date of the license.
mailDate (string, date): A mail date associated with the license.
militaryExtension (string): A military extension is associated with the license.
hasDriverTraining (string): Driver training is associated with the license.
renewalDate (string, date): The renewal date the license.
srFileType (string): The SR-Filling type of the license.
statusList (array): The license status.
name (string): The license status name.
description (string): The license status name.
endorsements (array): A list of endorsements associated with the license.
description (string): The endorsement name.
endDate (string, date): The end date of the endorsement.
startDate (string, date): The start date of the endorsement.
restrictions (array): A list of restrictions associated with the license.
description (string): The restriction name.
endDate (string, date): The end date of the restriction.
startDate (string, date): The start date of the restriction.
certificates (array): A list of certificates associated with the license.
description (string): The certificate name.
startDate (string, date): The start date of the certificate.
identification (object): A personal drivers license.
license (object): Return for a license type.
classDescription (string): The class description of the license.
classCode (string): The class code of the license.
issueDate (string, date): The issue date of the license.
expirationDate (string, date): The expiration date of the license.
mailDate (string, date): A mail date associated with the license.
militaryExtension (string): A military extension is associated with the license.
hasDriverTraining (string): Driver training is associated with the license.
renewalDate (string, date): The renewal date the license.
srFileType (string): The SR-Filling type of the license.
statusList (array): The license status.
name (string): The license status name.
description (string): The license status name.
endorsements (array): A list of endorsements associated with the license.
description (string): The endorsement name.
endDate (string, date): The end date of the endorsement.
startDate (string, date): The start date of the endorsement.
restrictions (array): A list of restrictions associated with the license.
description (string): The restriction name.
endDate (string, date): The end date of the restriction.
startDate (string, date): The start date of the restriction.
certificates (array): A list of certificates associated with the license.
description (string): The certificate name.
startDate (string, date): The start date of the certificate.
motorcycle (object, oneOf): A motorcycle driver's license.
license (object): Return for a license type.
classDescription (string): The class description of the license.
classCode (string): The class code of the license.
issueDate (string, date): The issue date of the license.
expirationDate (string, date): The expiration date of the license.
mailDate (string, date): A mail date associated with the license.
militaryExtension (string): A military extension is associated with the license.
hasDriverTraining (string): Driver training is associated with the license.
renewalDate (string, date): The renewal date the license.
srFileType (string): The SR-Filling type of the license.
statusList (array): The license status.
name (string): The license status name.
description (string): The license status name.
endorsements (array): A list of endorsements associated with the license.
description (string): The endorsement name.
endDate (string, date): The end date of the endorsement.
startDate (string, date): The start date of the endorsement.
restrictions (array): A list of restrictions associated with the license.
description (string): The restriction name.
endDate (string, date): The end date of the restriction.
startDate (string, date): The start date of the restriction.
certificates (array): A list of certificates associated with the license.
description (string): The certificate name.
startDate (string, date): The start date of the certificate.
permit(object): Returned for a permit type.
classDescription (string): The class description of the license.
classCode (string): The class code of the license.
issueDate (string, date): The issue date of the license.
expirationDate (string, date): The expiration date of the license.
mailDate (string, date): A mail date associated with the license.
militaryExtension (string): A military extension is associated with the license.
hasDriverTraining (string): Driver training is associated with the license.
renewalDate (string, date): The renewal date the license.
srFileType (string): The SR-Filling type of the license.
statusList (array): The license status.
name (string): The license status name.
description (string): The license status name.
endorsements (array): A list of endorsements associated with the license.
description (string): The endorsement name.
endDate (string, date): The end date of the endorsement.
startDate (string, date): The start date of the endorsement.
restrictions (array): A list of restrictions associated with the license.
description (string): The restriction name.
endDate (string, date): The end date of the restriction.
startDate (string, date): The start date of the restriction.
certificates (array): A list of certificates associated with the license.
description (string): The certificate name.
startDate (string, date): The start date of the certificate.
medicalCertificate (object): A medical certificate on public record.
restrictions (array): Restrictions associates with the medical certificate.
description (string): A normalized description of the restriction.
descriptionRaw (string): The description from the medical certificate.
selfCertification (array): A self-certification associated with the license.
effectiveDate (string, date): The effective date of the self-certification.
type (string): The type of certification.
typeCode (string): A type code of the self-certification.
examiner (array): The examiner associated with the medical certificate.
lastName (string): The examiner's last name.
firstName (string): The examiner's first name.
middleName (string): The examiner's middle name or initial.
suffix (string): The examiner's suffix, Suffix.
medicalExaminerLicense (string): The examiner's medical license associated with the medical certificate.
medicalExaminerLicenseState (string): The state associated with the medical license.
registrationNumber (string): The state registration number associated with the medical license.
phone (string): The phone number associated with the medical license.
specialtyDescription (string): The medical speciality associated with the medical license.
specialtyRaw (string): The medical speciality associated with the medical license from the state.
variances (array): Any variances associated with the certificate.
type (string): The type of variance.
expirationDate (string, date): The expiration date of the variance.
issuedDate (string, date): The issue date of the variance.
rescindedDate (string, date): The rescind date of the variance.
status (string): A status associated with the certificate.
statusRaw (string): A status associated with the certificate.
expirationDate (string, date): The expiration date of the medical certificate.
issuedDate (string, date): The issue date of the medical certificate.
wasReceived (string): Indicator the medical certificate was received.
downgradedDate (string, date): A downgraded date associated with the medical certificate.
downgradedEndDate (string, date): A downgraded end date associated with the medical certificate.
downgradedReason (string): A reason associated with the downgraded status.
downgradedDescription (string): A description associated with the downgraded status.
additional (string): An addition messages associated with the medical certificate.
previousLicenses (array): A list of previous licenses for the person.
license (object): A drivers license.
licenseState (string): The state issuing the license.
licenseNumber (string): The number of the license.
CDL (string): Indicates commercial driver's license, \"Y\", \"N\".
classCode (object): A drivers license class code.
(Required) A report's unique identifier.
\n","type":"text/plain"},"type":"any","value":"","key":"reportId"}]}},"response":[{"id":"3b9000a0-a54e-40a6-ba38-b40e9a317f8d","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}","description":"(Required) The unique identifier of the platform organization"},{"key":"Accept","value":"application/vnd.sambasafety.activityhistory+json;version=2.0.0"},{"key":"Authorization","value":"BearerActivity History is used for retrieving a historical violation detail report as an alternative to a State-Direct MVR.
\nAuthentication: Obtain a token to gain access
\nPlace an Order: Place an order to get data for the person
\nCheck Order Status: Check whether an order that has been placed has been fulfilled
\nGet a Report: Get the data ordered
\nFor more information on Activity History visit our SambaSafety Knowledge Base
\n","_postman_id":"246de67f-a5f1-4adc-9a86-b41d46aef872","auth":{"type":"apikey","apikey":{"key":"This endpoint creates a new order for a CDLIS Report for a single driver.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept:
application/jsonX-Api-Key: [ApiKey]
Parameters:
\nfirstName (string(40), optional): The person's given name, as indicated on the document.
middleName (string(20), optional): The person's middle name or initial, if indicated on the document.
lastName (string(40), required): The person's family name, as indicated on the document.
birthDate (string, date, required): The person's date of birth. \"YYYY-MM-DD\"
ssn (string(9), required): A person's social security number. 9 numerical characters (no hypans)
billCode (string(100), optional): A customer's custom billing code - passes to billing details
billReference (string,(250) optional): A customer's custom billing reference note - passes to billing
The response for this request is a JSON schema
\nResponse variations linked here
\n","auth":{"type":"apikey","apikey":{"key":"application/JSON
application/vnd.sambasafety.cdlis+html;version=1.0.0
Retrieve and existing order with orderID
\n","auth":{"type":"apikey","apikey":{"key":"The CDLIS API allows customers to purchase on-demand list of all commercial driver's licenses on a person (up to four)
\nAuthentication: Obtain a token to gain access
\nPlace an Order: Place an order to get CDL license records for a person. This is a synchrounous call and the report is retuend in the response.
\nGet a Report on a Person: Obtain a previously ordered report with orderId
\nFor more information on CDLIS capability visit our SambaSafety Knowledge Base
\n","_postman_id":"1f0f002f-9544-41da-974d-806e7c0338da","auth":{"type":"apikey","apikey":{"key":"(Required) The unique identifier of the platform organization
\n"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/transactional/v1/mvrorders?page=1&size=50","description":"This endpoint retrieves list of previouss orders placed for the Service. The request does not include a request body. Upon successful request, the API will respond with a list of previously placed orders, including the current order status.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: application/json
X-Api-Key: [ApiKey]
Parameters:
\npage:the page of transactions to review. Default value: 1
size:the number of transactions to review on a page. Default value:25
Parameters:
\ndata
mvrOrderId (string, uuid): The order's unique identifier.
orderStatus (string): The order status, 'pending', 'fulfilled','error'.
orderDateTime (string, datetime): The timestamp of the order.
license (object): The license object containing:
licenseState (string): The license's issuing state.
licenseNumber (string): The license's document number.
subType (string): A SambaSafety identifier for the order.
billCode (string): A customer's custom billing code.
billReference (string): A customer's custom billing reference note.
meta
totalPages (number): The total number of pages.links
self (string, url): The URL to the current page.
first (string, url): The URL to the first page of data.
next (string, url): The URL to the next page of data.
prev (string, url): The URL to the previous page of data.
last (string, url): The URL to the last page of data.
The page of data being displayed.
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"The number of items on a page.
\n","type":"text/plain"},"key":"size","value":"50"}],"variable":[]}},"response":[{"id":"35a2f52f-328e-4eb5-abde-b0fa3ca456d1","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}","description":"(Required) The unique identifier of the platform organization"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer(Required) The unique identifier of the platform organization
\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"licenseState\": \"CO\",\n \"licenseNumber\": \"000000000\",\n \"birthDate\": \"1980-01-01\",\n \"firstName\": \"Chris\",\n \"lastName\": \"Bacon\",\n \"middleName\": \"P\",\n \"gender\": \"F\",\n \"ssn\": \"8987\",\n \"stateAccessCode\": \"abcd9\",\n \"originationId\":\"999888765\",\n \"billCode\": \"note - value that will populate on billing details\",\n \"billReference\": \"note-value that will populate on billing details\",\n \"productId\": \"DL\",\n \"subType\": \"7Y\",\n \"host\": \"ONLINE\",\n \"purpose\": \"EMPLOYMENT\",\n \"customFields\": [\n {\n \"name\": \"regions\",\n \"value\": \"northeast, northwest\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/transactional/v1/mvrorders","description":"This endpoint creates a new order for a (State-Direct) Transactional MVR
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: application/json
X-Api-Key: [ApiKey]
Parameters:
\nproductId (string, required): The state product code. \"DL\" is the default value.
subType (string, required): The state's sub type of MVR. [\"3Y\", \"5Y\", \"7Y\", \"EM\", \"DB\", \"CR\"]
host (string, required): The method of ordering. [\"ONLINE\", \"OVERNIGHT\"] : OVERNIGHT-HI, MO, and CA only
purpose (string, required): The purpose for requesting the MVR. [\"EMPLOYMENT\", \"INSURANCE\"]
licenseState (string(2), required, ALL CAPS): The state jurisdiction issuing the document.
licenseNumber (string(30), required): The number of the document. License Nmber Formats
birthDate (string, date, required): The person's date of birth. \"YYYY-MM-DD\"
lastName (string(40), required): The person's family name, as indicated on the document.
firstName (string(40), required): The person's given name, as indicated on the document.
middleName (string(20), optional): The person's middle name or initial, if indicated on the document.
gender (string, optional): The person's gender: [\"M, F, X\"]
ssn (string, optional): The person's social security number. [\"4\",\"9\"] digits without dashes.
customfields (Array[object], optional): A customer's custom fields. Enterprise Only
name (string(50), optional): Value that triggers customer scoring.
value (string(255), optional): Value that triggers customer scoring.
billCode (string(100), optional): A customer's custom billing code.
billReference (string(250), optional): A customer's custom billing reference note.
stateAccessCode (string (20), optional): CA and PA require access codes. Can be sent in a request or set up on the backend.
originationId (string(40),optional): pass to access smart sync capability. [1-40 alphanumeric characters]
customerOrgId (string(20), optional): Required in the state of Utah to make a single order .
subvendorOrgId (string(20), optional): Required in the state of Utah when a reseller purchases on behave of a customer.
Upon successful request, the API will respond with the a 201 Created containing the order ID.
\nParameters:
\norderId (string, uuid): The order's unique identifier.(Required) The unique identifier of the platform organization
\n"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/transactional/v1/mvrorders/:orderId","description":"This endpoint retrieves summary information for the corresponding order ID. The request does not include a request body.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: application/json
X-Api-Key: [ApiKey]
Parameters:
\norderId the unique identifer for the order.Upon successful request, the API will respond with details for the corresponding order. Contains the orderStatus and a links reference to the report, when completed.
\nParameters:
\nmvrOrderId (string, uuid): The order's unique identifier.
orderStatus (string): The status of the order.
orderDateTime (string, datetime): The timestamp of the order.
license (object): The license object containing:
licenseState (string): The license's issuing state.
licenseNumber (string): The license's document number.
subType (string): A SambaSafety identifier for the order.
billCode (string): A customer's custom billing code.
billReference (string): A customer's custom billing reference note.
links (object): An array of links related to the order.
rel (string): The relationship of the link.
href (string): The URL of the link.
type (string): The HTTP Method used to access the link.
id (string): The unique identifier associated with the link.
If you have subscribed to the webhook when the order has been successfully \"fulfilled\", the CallbackURL will be invoked with a \"POST\" and a body containing a url link to the report, and the report uuid.
\nIf an error occurs, the response will have an “error\" event type, with a description of the error.
\ntransactionalmvr.received
transactionalmvr.error
Parameters:
\neventId (string, uuid): The callback event's unique identifier.
data (object): The order summary object containing:
mvrId (string, uuid): The order's unique identifier.
links (array): An array of links related to the order.
rel (string): The relationship of the link.
href (string): The URL of the link.
type (string): The HTTP Method used to access the link.
id (string): The unique identifier associated with the link.
mvrDateTime (string, datetime): The timestamp of the MVR order.
createdDateTime (string, date): The callback event's timestamp.
eventType (string): The callback event name.
(Required) The order's unique identifier.
\n","type":"text/plain"},"type":"any","value":"","key":"orderId"}]}},"response":[{"id":"c1e7fea5-fd0e-4264-ac3f-a872933cf1be","name":"200 OK: Status: Fulfilled","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}","description":"(Required) The unique identifier of the platform organization"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer(Required) The unique identifier of the platform organization
\n"},{"key":"Accept","value":"application/vnd.sambasafety.qorta.mvr+json;version=3.0.0"}],"url":"{{baseUrl}}/reports/v1/motorvehiclereports/:reportId","description":"This endpoint retrieves Transactional MVR for the corresponding Report ID.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: [Document Version]
X-Api-Key: [ApiKey]
Available Versions:
\napplication/vnd.sambasafety.qorta.mvr+json;version=3.0.0 (Default)
\napplication/vnd.sambasafety.qorta.scoring mvr+json;version=3.0.0
\napplication/vnd.sambasafety.qorta.mvr+json;version=2.0.4
\napplication/vnd.sambasafety.qorta.mvr+xml;version=2.0.3
\napplication/vnd.sambasafety.qorta.mvr+xml;version=2.0.2
\napplication/vnd.sambasafety.qorta.mvr+xml;version=2.0.0
\napplication/vnd.sambasafety.qorta.mvr+html
\napplication/vnd.sambasafety.qorta.mvr+html;version=3.1
\napplication/vnd.sambasafety.qorta.mvr+pdf ( Base64 Encoded String )
\napplication/vnd.sambasafety.qorta.mvr+epnformat
\nParameters:
\nreportId: the unique identifer for the Transactional MVR Report.Upon successful request, the API will respond with the Transactional MVR Report for the reportId and report version requested.
application/vnd.sambasafety.qorta.mvr+json;version=3.0.0
\napplication/vnd.sambasafety.qorta.mvr+json;version=2.0.4
\n(Required) A report's unique identifier.
\n","type":"text/plain"},"type":"any","value":"","key":"reportId"}]}},"response":[{"id":"59f2ffcc-0869-4aa8-8cf3-dd4a998c28df","name":"200 OK Version=3.0.0","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}","description":"(Required) The unique identifier of the platform organization"},{"key":"Accept","value":"application/vnd.sambasafety.qorta.mvr+json;version=3.0.0"},{"key":"Authorization","value":"BearerThe Transactional MVR service allows customers to purchase on-demand MVRs for pre-hire employment and/or insurance purposes.
\nAuthentication: Obtain a token to gain access
\nPlace an Order: Place an order to get data for the person
\nCheck Order Status: Check whether an order that has been placed has been fulfilled
\nGet a Report: Get the data ordered
\nFor more information on Transactional MVR API and/or Motor Vehicle Reports visit our SambaSafety Knowledge Base
\n","_postman_id":"dde5ba9f-dee8-4ecb-9c96-9249c00493d4","auth":{"type":"apikey","apikey":{"key":"(Required) The unique identifier of the platform organization
\n"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/orders/v1/licensereports/verifydriver?page=1&size=50&startOrderDate=2023-01-01&endOrderDate=2023-09-15","description":"This endpoint retrieves list of previouss orders placed for the Service. The request does not include a request body. Upon successful request, the API will respond with a list of previously placed orders, including the current order status.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: application/json
X-Api-Key: [ApiKey]
Parameters:
\npage:the page of transactions to review. Default value: 1
size:the number of transactions to review on a page. Default value:25
startOrderDate: Start date when orders were created. If value is not provided, search will default to midnight (00:00:00 a.m.) of previous day.
endOrderDate Inclusive end date when orders were created. If value is not provided, search will default to end of day (23:59:59 p.m.).
Parameters:
\ndata
errorMessage (string): An error message attached to the order.
orderId (string, uuid): The license's unique identifier.
status (string): The enrollment type.
request (object): The order request object from Place an Order.
createdDateTime (string, datetime): The timestamp of the order.
meta
totalPages (number): The total number of pages.
totalRecords (number): The total number of records.
links
self (string, url): The URL to the current page.
first (string, url): The URL to the first page of data.
next (string, url): The URL to the next page of data.
prev (string, url): The URL to the previous page of data.
last (string, url): The URL to the last page of data.
The page of data being displayed.
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"The number of items on a page.
\n","type":"text/plain"},"key":"size","value":"50"},{"description":{"content":"Start date when orders were created. If value is not provided, search will default to midnight (00:00:00 a.m.) of previous day.
\nPattern: yyyy-MM-dd
\n","type":"text/plain"},"key":"startOrderDate","value":"2023-01-01"},{"description":{"content":"Inclusive end date when orders were created. If value is not provided, search will default to end of day (23:59:59 p.m.).
\nPattern: yyyy-MM-dd
\n","type":"text/plain"},"key":"endOrderDate","value":"2023-09-15"}],"variable":[]}},"response":[{"id":"9cfa5352-a5f1-4015-88e1-e92be58876a3","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}","description":"(Required) The unique identifier of the platform organization"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer(Required) The unique identifier of the platform organization
\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"purpose\": \"INSURANCE\",\n \"licenseNumber\": \"1234567890\",\n \"licenseState\": \"CA\",\n \"firstName\": \"John\",\n \"lastName\": \"Alpha\",\n \"birthDate\": \"1980-08-16\",\n \"address\": {\n \"street\": \"495 Grove Street\",\n \"city\": \"Boulder\",\n \"state\": \"CO\",\n \"zipCode\": \"80301\"\n },\n \"middleName\": \"\",\n \"suffix\": \"\",\n \"billCode\": \"\",\n \"billReference\": \"\",\n \"customFields\": [\n {\n \"name\": \"Custom Field\",\n \"value\": \"Custom Value\"\n }\n ],\n \"licenseCategory\": \"LICENSE\",\n \"issueDate\": \"1998-08-16\",\n \"expiryDate\": \"2008-08-16\",\n \"eyeColor\": \"BLACK\",\n \"gender\": \"MALE\",\n \"height\": 510,\n \"weight\": 195\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/orders/v1/licensereports/verifydriver","description":"This endpoint creates a new order for an Foreign License Discovery Report, for a single driver.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: application/json
X-Api-Key: [ApiKey]
Parameters:
\npurpose (string, required): The purpose of the order. [\"EMPLOYEMENT\", \"INSURANCE\"]
licenseCategory (string, required): The document's category, License Category.
licenseState (string, required): The state jurisdiction issuing the document, US State Abbreviation.
birthDate (string, date, required): The person's date of birth.
lastName (string, required): The person's family name, as indicated on the document.
firstName (string, required): The person's given name, as indicated on the document.
middleName (string, optional): The person's middle name or initial, if indicated on the document.
suffix (string, optional): The person's family suffix, Suffix.
address (object, optional): An address object containing:
street (string): The person's mailing street address.
city (string): The person's mailing municipality.
state (string): The person's mailing state, US State Abbreviation.
zipCode (string): The person's mailing postal code.
gender (string, optional): The person's gender, Gender.
height (number, optional): The person's height.
weight (number, optional): The person's weight.
eyeColor (string, optional): The person's eye-color, Eye-Color.
issueDate (string, date, optional): The document's issue date.
expiryDate (string, date, optional): The document's expiration dat
billCode (string, optional): A customer's custom billing code.
billReference (string, optional): A customer's custom billing reference note.
Upon successful request, the API will respond with the a 201 Created containing the order ID.
\nParameters:
\norderId (string, uuid): The order's unique identifier.(Required) The unique identifier of the platform organization
\n"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/orders/v1/licensereports/verifydriver/:orderId","description":"This endpoint retrieves summary information for the corresponding order ID. The request does not include a request body.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: application/json
X-Api-Key: [ApiKey]
Parameters:
\norderId the unique identifer for the order.Upon successful request, the API will respond with details for the corresponding order. Contains the orderStatus and a links reference to the report, when completed.
\nParameters:
\norderId (string, uuid): The order's unique identifier.
orderStatus (string): The status of the order.
orderDateTime (string, datetime): The timestamp of the order.
orderCompletedDateTime (string, datetime): The timestamp of the order was completed.
controlNumber (string): A SambaSafety identifier for the order.
links (object): An array of links related to the order.
rel (string): The relationship of the link.
href (string): The URL of the link.
type (string): The HTTP Method used to access the link.
id (string): The unique identifier associated with the link.
If you have subscribed to the webhook when the order has been successfully \"fulfilled\", the CallbackURL will be invoked with a \"POST\" and a body containing a url link to the report, and the report uuid.
\nIf an error occurs, the response will have an “error\" event type, with a description of the error.
\nlicensediscovery.received
licensediscovery.error
Parameters:
\neventId (string, uuid): The callback event's unique identifier.
data (object): The order summary object containing:
orderId (string, uuid): The order's unique identifier.
links (array): An array of links related to the order.
rel (string): The relationship of the link.
href (string): The URL of the link.
type (string): The HTTP Method used to access the link.
id (string): The unique identifier associated with the link.
orderDate (string, datetime): The timestamp of the order.
productOrdered (string): The product ordered (subType).
createdDateTime (string, date): The callback event's timestamp.-
eventType (string): The callback event name.
(Required) The order's unique identifier.
\n","type":"text/plain"},"type":"any","value":"","key":"orderId"}]}},"response":[{"id":"a9431d82-021d-4f73-930f-20a6076d7d4b","name":"200 OK: Status: Fulfilled","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}","description":"(Required) The unique identifier of the platform organization"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer(Required) The unique identifier of the platform organization
\n"},{"key":"Accept","value":"application/vnd.sambasafety.json;version=2.0.4"}],"url":"{{baseUrl}}/reports/v1/licensereports/verifydriver/:reportId","description":"This endpoint retrieves License Discovery Report for the corresponding Report ID.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: [Document Version]
X-Api-Key: [ApiKey]
Available Versions:
\napplication/vnd.sambasafety.json;version=2.0.4
\napplication/vnd.sambasafety.xml;version=2.0.3
\napplication/vnd.sambasafety.xml;version=2.0.2
\napplication/vnd.sambasafety.xml;version=2.0.0
\napplication/vnd.sambasafety.html
\napplication/vnd.sambasafety.pdf ( Base64 Encoded String )
\nParameters:
\nreportId: the unique identifer for the License Discovery Report.Upon successful request, the API will respond with the License Discovery Report for the reportId and report version requested.
Parameters:
\nRecord
DlRecord
Criteria(object): Contains parameters sent with the request.
OrderDate(object): Contains the date parameters of when the order was placed.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
OrderTime(object): Contains the time parameters of when the order was placed.
Hour(string): The time's hour component [0-23].
Minute(string): The time's minute component [0-59].
Second(string): The time's second component [0-59].
AccountID(string): The account the order was placed under.
UserID(string): The account user who placed the order.
Routing(string): An internal system routing id.
TrackingNumber(string): An internal system tracking number.
Host(string): The internal service identifier.
ProductID(string): The internal product code for the order.
State(object): The license state provided in the request.
Abbrev(string): The state's abbreviation.
Full(string): The state's full name.
Subtype(string): A code indicating a product subtype.
SubtypeFull(string): The full name for the product subtype.
FirstName(string): The first name provided in the request.
LastName(string): The last name provided in the request.
BirthDate(string): The birth date provided in the request.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
OrderLookBackEndDate(string): The look back date determined from the request.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
Result(object): Contains the results of the order.
Control(string): An internal control number for the order.
Valid(string): A [Y,N] indicator that the order was valid.
ErrorCode(string): A code for associated with an error.
ErrorDescription(string): A message describing the result.
ReturnedDate(object): Contains the date parameters of when the order was returned.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ReturnTime(object): Contains the time parameters of when the order was returned.
Hour(string): The time's hour component [0-23].
Minute(string): The time's minute component [0-59].
Second(string): The time's second component [0-59].
ReportPeriod(string): A description of the report period.
CompanyClass(string): A company class code used for custom scoring.
CompanyScore(string): A company score assigned for custom scoring.
IsClear(string): A [Y, N] clear indicator.
IsFromArchive(string): A [Y, N] vault record indicator.
InvoicePath(string): The invoice path.
ResultCode(string): A code for the result.
Driver(object): An object representing the driver.
FirstName(string): The first name of the driver.
MiddleName(string): The middle name of the driver.
LastName(string): The last name of the driver.
SuffixName(string): The suffix name of the driver.
BirthDate(object): Contains the date parameters for the birth date of the driver.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
Age(string): The age of the driver.
EyeColor(string): The eye color of the driver.
HairColor(string): The hair color of the driver.
Weight(string): The weight of the driver.
Height(string): The height of the driver.
Gender(string): The gender of the driver.
Deceased(string): A [Y,N] indicator if the driver is deceased.
AddressList(array): An array representing addresses.
Street(string): The street address.
City(string): The city where the address is located.
State(string): The state where the address is located.
Abbrev(string): The state's abbreviation.
Full(string): The state's full name.
Zip(string): The postal code for the address.
ConfidenceMatch(string): The confidence score of the discovered driver.
LicenseNumber (string) The discovered license number.
LicenseHistoryList(array): A report object that contains a drivers historic licenses.
Type(string): Type of license, for example personal, commercial, identification.
ClassDescription(string): Detailed license class description type.
ClassCode(string): The state's license class code.
IssueDate(object): Contains the date parameters of when the license was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the license will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
StatusList(array): A response element contains information on the status of the license.
Name(string): Driver's license status name.
Explanation(string): Additional status information from the state.
(Required) A report's unique identifier.
\n","type":"text/plain"},"type":"any","value":"","key":"reportId"}]}},"response":[{"id":"112a94e0-39bd-42ad-837d-7e7e52b1b8d3","name":"200 OK: Confidence Match 100%","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}","description":"(Required) The unique identifier of the platform organization"},{"key":"Accept","value":"application/vnd.sambasafety.json;version=2.0.4"},{"key":"Authorization","value":"BearerThe foreign License Discovery service allows a customer to verify if a driver has ever had a US license. The primary use case is for insurers to limit premium leakage and risk exposure by confirming if a foreign driver has ever held a US license.
\nCA and TX are the only states that support this product as these states see high numbers of foreign drivers that claim to not have US drivers licenses.
\nAuthentication: Obtain a token to gain access
\nPlace an Order: Place an order to get data for the person
\nCheck Order Status: Check whether an order that has been placed has been fulfilled
\nGet a Report: Get the data ordered
\nFor more information on License Discovery visit our SambaSafety Knowledge Base
\n","_postman_id":"fbbf3bc9-1e0f-40aa-869b-51f024276bb4","auth":{"type":"apikey","apikey":{"key":"(Required) The unique identifier of the platform organization
\n"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/orders/v1/activityreports/indicator?page=1&size=50&startOrderDate=2023-01-01&endOrderDate=2023-09-15","description":"This endpoint retrieves list of previouss orders placed for the Service. The request does not include a request body. Upon successful request, the API will respond with a list of previously placed orders, including the current order status.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: application/json
X-Api-Key: [ApiKey]
Parameters:
\npage:the page of transactions to review. Default value: 1
size:the number of transactions to review on a page. Default value:25
startOrderDate: Start date when orders were created. If value is not provided, search will default to midnight (00:00:00 a.m.) of previous day.
endOrderDate Inclusive end date when orders were created. If value is not provided, search will default to end of day (23:59:59 p.m.).
Parameters:
\ndata
errorMessage (string): An error message attached to the order.
orderId (string, uuid): The license's unique identifier.
status (string): The enrollment type.
request (object): The order request object from Place an Order.
createdDateTime (string, datetime): The timestamp of the order.
meta
totalPages (number): The total number of pages.
totalRecords (number): The total number of records.
links
self (string, url): The URL to the current page.
first (string, url): The URL to the first page of data.
next (string, url): The URL to the next page of data.
prev (string, url): The URL to the previous page of data.
last (string, url): The URL to the last page of data.
The page of data being displayed.
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"The number of items on a page.
\n","type":"text/plain"},"key":"size","value":"50"},{"description":{"content":"Start date when orders were created. If value is not provided, search will default to midnight (00:00:00 a.m.) of previous day.
\nPattern: yyyy-MM-dd
\n","type":"text/plain"},"key":"startOrderDate","value":"2023-01-01"},{"description":{"content":"Inclusive end date when orders were created. If value is not provided, search will default to end of day (23:59:59 p.m.).
\nPattern: yyyy-MM-dd
\n","type":"text/plain"},"key":"endOrderDate","value":"2023-09-15"}],"variable":[]}},"response":[{"id":"8fc6c263-c12a-4887-b839-fd2a0c6d6c25","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}","description":"(Required) The unique identifier of the platform organization"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer(Required) The unique identifier of the platform organization
\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"birthDate\": \"1980-08-16\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"licenseNumber\": \"1234567890\",\n \"purpose\": \"INSURANCE\",\n \"licenseState\": \"CA\",\n \"middleName\": \"Alexander\",\n \"suffix\": \"\",\n \"billCode\": \"\",\n \"billReference\": \"\",\n \"options\": [\n \"LICENSE_VALIDATION\"\n ],\n \"customFields\": [\n {\n \"name\": \"Custom Field\",\n \"value\": \"Custom Value\"\n }\n ],\n \"licenseCategory\": \"LICENSE\",\n \"issueDate\": \"1998-08-16\",\n \"expiryDate\": \"2008-08-16\",\n \"eyeColor\": \"BLACK\",\n \"gender\": \"MALE\",\n \"address\": {\n \"street\": \"495 Grove Street\",\n \"city\": \"Boulder\",\n \"state\": \"CO\",\n \"zipCode\": \"80301\"\n },\n \"height\": 510,\n \"weight\": 195,\n \"activityDuration\": 24\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/orders/v1/activityreports/indicatorquote","description":"This endpoint creates a new order for an Activity Indicator Report, using the SambaSafety Quote feature.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: application/json
X-Api-Key: [ApiKey]
Parameters:
\npurpose (string, required): The purpose of the order. [\"EMPLOYMENT\", \"INSURANCE\"]
licenseCategory (string, required): The document's category, License Category.
licenseState (string, required): The state jurisdiction issuing the document, US State Abbreviation.
licenseNumber (string, required): The person's family name, as indicated on the document.
birthDate (string, date, required): The person's date of birth.
lastName (string, required): The person's family name, as indicated on the document.
firstName (string, required): The person's given name, as indicated on the document.
middleName (string, optional): The person's middle name or initial, if indicated on the document.
suffix (string, optional): The person's family suffix, Suffix.
address (object, optional): An address object containing:
street (string): The person's mailing street address.
city (string): The person's mailing municipality.
state (string): The person's mailing state, US State Abbreviation.
zipCode (string): The person's mailing postal code.
gender (string, optional): The person's gender, Gender.
height (number, optional): The person's height.
weight (number, optional): The person's weight.
eyeColor (string, optional): The person's eye-color, Eye-Color.
issueDate (string, date, optional): The document's issue date.
expiryDate (string, date, optional): The document's expiration date.
options (Array[string], optional): A list of bundled options. i.e. \"LICENSE_VALIDATION\"
customFields (Array[object], optional): A customer's custom fields.
billCode (string, optional): A customer's custom billing code.
billReference (string, optional): A customer's custom billing reference note.
activityDuration (number, optional): The number of months of activity.
Upon successful request, the API will respond with the a 201 Created containing the order ID.
\nParameters:
\norderId (string, uuid): The order's unique identifier.(Required) The unique identifier of the platform organization
\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"birthDate\": \"1980-08-16\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"licenseNumber\": \"S20180511005\",\n \"licenseState\": \"IL\",\n \"middleName\": \"Alexander\",\n \"suffix\": \"\",\n \"billCode\": \"\",\n \"billReference\": \"\",\n \"purpose\": \"INSURANCE\",\n \"options\": [\n \"LICENSE_VALIDATION\"\n ],\n \"customFields\": [\n {\n \"name\": \"Custom Field\",\n \"value\": \"Custom Value\"\n }\n ],\n \"licenseCategory\": \"LICENSE\",\n \"issueDate\": \"1998-08-16\",\n \"expiryDate\": \"2008-08-16\",\n \"eyeColor\": \"BLACK\",\n \"gender\": \"MALE\",\n \"address\": {\n \"street\": \"495 Grove Street\",\n \"city\": \"Boulder\",\n \"state\": \"CO\",\n \"zipCode\": \"80301\"\n },\n \"height\": 510,\n \"weight\": 195,\n \"vaultAge\": 30\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/orders/v1/activityreports/indicator","description":"This endpoint creates a new order for an Activity Indicator Report, for a single driver.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: application/json
X-Api-Key: [ApiKey]
Parameters:
\npurpose (string, required): The purpose of the order. [\"EMPLOYMENT\", \"INSURANCE\"]
licenseCategory (string, required): The document's category, License Category.
licenseState (string, required): The state jurisdiction issuing the document, US State Abbreviation.
licenseNumber (string, required): The person's family name, as indicated on the document.
birthDate (string, date, required): The person's date of birth.
lastName (string, required): The person's family name, as indicated on the document.
firstName (string, required): The person's given name, as indicated on the document.
middleName (string, optional): The person's middle name or initial, if indicated on the document.
suffix (string, optional): The person's family suffix, Suffix.
address (object, optional): An address object containing:
street (string): The person's mailing street address.
city (string): The person's mailing municipality.
state (string): The person's mailing state, US State Abbreviation.
zipCode (string): The person's mailing postal code.
gender (string, optional): The person's gender, Gender.
height (number, optional): The person's height.
weight (number, optional): The person's weight.
eyeColor (string, optional): The person's eye-color, Eye-Color.
issueDate (string, date, optional): The document's issue date.
expiryDate (string, date, optional): The document's expiration date.
options (Array[string], optional): A list of bundled options. i.e. \"LICENSE_VALIDATION\"
customFields (Array[object], optional): A customer's custom fields.
billCode (string, optional): A customer's custom billing code.
billReference (string, optional): A customer's custom billing reference note.
vaultAge (number, optional): Integer value for vault age in days.
Values accepted:
0 = no vault allowed
\n1-1095 = days
\nUpon successful request, the API will respond with the a 201 Created containing the order ID.
\nParameters:
\norderId (string, uuid): The order's unique identifier.(Required) The unique identifier of the platform organization
\n"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/orders/v1/activityreports/indicator/:orderId","description":"This endpoint retrieves summary information for the corresponding order ID. The request does not include a request body.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: application/json
X-Api-Key: [ApiKey]
Parameters:
\norderId the unique identifer for the order.Upon successful request, the API will respond with details for the corresponding order. Contains the orderStatus and a links reference to the report, when completed.
\nParameters:
\norderId (string, uuid): The order's unique identifier.
orderStatus (string): The status of the order.
orderDateTime (string, datetime): The timestamp of the order.
orderCompletedDateTime (string, datetime): The timestamp of the order was completed.
controlNumber (string): A SambaSafety identifier for the order.
links (object): An array of links related to the order.
rel (string): The relationship of the link.
href (string): The URL of the link.
type (string): The HTTP Method used to access the link.
id (string): The unique identifier associated with the link.
If you have subscribed to the webhook when the order has been successfully \"fulfilled\", the CallbackURL will be invoked with a \"POST\" and a body containing a url link to the report, and the report uuid.
\nIf an error occurs, the response will have an “error\" event type, with a description of the error.
\nactivityindicator.received
activityindicator.error
Parameters:
\neventId (string, uuid): The callback event's unique identifier.
data (object): The order summary object containing:
orderId (string, uuid): The order's unique identifier.
links (array): An array of links related to the order.
rel (string): The relationship of the link.
href (string): The URL of the link.
type (string): The HTTP Method used to access the link.
id (string): The unique identifier associated with the link.
orderDate (string, datetime): The timestamp of the order.
productOrdered (string): The product ordered (subType).
createdDateTime (string, date): The callback event's timestamp.-
eventType (string): The callback event name.
(Required) The order's unique identifier.
\n","type":"text/plain"},"type":"any","value":"","key":"orderId"}]}},"response":[{"id":"5e537cb9-47ec-49ab-a1a5-963fe8f4279b","name":"200 OK: Status: Fulfilled","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}","description":"(Required) The unique identifier of the platform organization"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer(Required) The unique identifier of the platform organization
\n"},{"key":"Accept","value":"application/vnd.sambasafety.json;version=2.0.4"}],"url":"{{baseUrl}}/reports/v1/activityreports/indicator/:reportId","description":"This endpoint retrieves Activity Indicator Report for the corresponding Report ID.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: application/json
X-Api-Key: [ApiKey]
Available Versions:
\napplication/vnd.sambasafety.json;version=2.0.4
\napplication/vnd.sambasafety.xml;version=2.0.3
\napplication/vnd.sambasafety.xml;version=2.0.2
\napplication/vnd.sambasafety.xml;version=2.0.0
\napplication/vnd.sambasafety.html
\napplication/vnd.sambasafety.pdf ( Base64 Encoded String )
\nParameters:
\nreportId: the unique identifier for the Activity Indicator Report.Upon successful request, the API will respond with the Activity Indicator Report for the reportId and report version requested.
Parameters:
\nRecord
DlRecord
Criteria (object) Contains parameters sent with the request.
OrderDate (object) Contains the date parameters of when the order was placed.
Year (number) The date's year component.
Month (number) The date's month component.
Day (number) The date's day component.
Full (string) The date in string format.
Ticks (number) The date's numeric equivalent.
OrderTime (object) Contains the time parameters of when the order was placed.
Hour (string) The time's hour component [0-23].
Minute (string) The time's minute component [0-59].
Second (string) The time's second component [0-59].
AccountID (string) The account the order was placed under.
UserID (string) The account user who placed the order.
Routing (string) An internal system routing id.
TrackingNumber (string) An internal system tracking number.
Host (string) The internal service identifier.
ProductID (string) The internal product code for the order.
State (object) The license state provided in the request.
Abbrev (string) The state's abbreviation.
Full (string) The state's full name.
Subtype (string) A code indicating a product subtype.
SubtypeFull (string) The full name for the product subtype.
FirstName (string) The first name provided in the request.
LastName (string) The last name provided in the request.
BirthDate (string) The birth date provided in the request.
Year (number) The date's year component.
Month (number) The date's month component.
Day (number) The date's day component.
Full (string) The date in string format.
Ticks (number) The date's numeric equivalent.
LicenseNumber (string) The license number provided in the request.
Source (string) A internal source code.
Result (object) Contains the results of the order.
Control (string) An internal control number for the order.
Valid (string) A [Y,N] indicator that the order was valid.
ErrorDescription (string) A message describing the result.
ReturnedDate (object) Contains the date parameters of when the order was returned.
Year (number) The date's year component.
Month (number) The date's month component.
Day (number) The date's day component.
Full (string) The date in string format.
Ticks (number) The date's numeric equivalent.
ReturnTime (object) Contains the time parameters of when the order was returned.
Hour (string) The time's hour component [0-23].
Minute (string) The time's minute component [0-59].
Second (string) The time's second component [0-59].
IsClear (string) A [Y, N] clear indicator.
InvoicePath (string) The invoice path.
ResultCode (string) A code for the result.
Driver(object): An object representing the driver.
FirstName(string): The first name of the driver.
MiddleName(string): The middle name of the driver.
LastName(string): The last name of the driver.
SuffixName(string): The suffix name of the driver.
CurrentLicense(object): A report object that contains a drivers active licenses.
Number(string): The current license number.(Required) A report's unique identifier.
\n","type":"text/plain"},"type":"any","value":"","key":"reportId"}]}},"response":[{"id":"355741a2-7e9f-4c07-8019-be980168205a","name":"200 OK: Clean Stub","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}","description":"(Required) The unique identifier of the platform organization"},{"key":"Accept","value":"application/vnd.sambasafety.json;version=2.0.4"},{"key":"Authorization","value":"BearerThe Activity Indicator service interrogates SambaSafety’s proprietary datasets using the personal identifiers submitted to locate records that can verify license activity, enabling insurance carriers to reduce data spend and improve underwriting efficiencies, and optimize workflows and speed up onboarding of drivers for companies.
\nChecks for new activity from the order date of the last MVR or vault record, up to a 3 year look back.
\nProvides “Activity” or “Clean” indicator to note if there is activity since the previous MVR order date, thus eliminating fees associated with ordering records on clean drivers.
\nAuthentication: Obtain a token to gain access
\nPlace an Order: Place an order to get data for the person
\nCheck Order Status: Check whether an order that has been placed has been fulfilled
\nGet a Report: Get the data ordered
\nFor more information on Activity Indicator visit our SambaSafety Knowledge Base
\n","_postman_id":"0884603e-6f71-458e-9d95-c74f2f740a29","auth":{"type":"apikey","apikey":{"key":"(Required) The unique identifier of the platform organization
\n"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/orders/v1/mvrreports/activity?page=1&size=50&startOrderDate=2023-01-01&endOrderDate=2023-09-15","description":"This endpoint retrieves list of previouss orders placed for the Service. The request does not include a request body. Upon successful request, the API will respond with a list of previously placed orders, including the current order status.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: application/json
X-Api-Key: [ApiKey]
Parameters:
\npage:the page of transactions to review. Default value: 1
size:the number of transactions to review on a page. Default value:25
startOrderDate: Start date when orders were created. If value is not provided, search will default to midnight (00:00:00 a.m.) of previous day.
endOrderDate Inclusive end date when orders were created. If value is not provided, search will default to end of day (23:59:59 p.m.).
Parameters:
\ndata
errorMessage (string): An error message attached to the order.
orderId (string, uuid): The license's unique identifier.
status (string): The enrollment type.
request (object): The order request object from Place an Order.
createdDateTime (string, datetime): The timestamp of the order.
meta
totalPages (number): The total number of pages.
totalRecords (number): The total number of records.
links
self (string, url): The URL to the current page.
first (string, url): The URL to the first page of data.
next (string, url): The URL to the next page of data.
prev (string, url): The URL to the previous page of data.
last (string, url): The URL to the last page of data.
The page of data being displayed.
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"The number of items on a page.
\n","type":"text/plain"},"key":"size","value":"50"},{"description":{"content":"Start date when orders were created. If value is not provided, search will default to midnight (00:00:00 a.m.) of previous day.
\nPattern: yyyy-MM-dd
\n","type":"text/plain"},"key":"startOrderDate","value":"2023-01-01"},{"description":{"content":"Inclusive end date when orders were created. If value is not provided, search will default to end of day (23:59:59 p.m.).
\nPattern: yyyy-MM-dd
\n","type":"text/plain"},"key":"endOrderDate","value":"2023-09-15"}],"variable":[]}},"response":[{"id":"f483fbf1-4c48-4437-a825-e74b7483d703","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}","description":"(Required) The unique identifier of the platform organization"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer(Required) The unique identifier of the platform organization
\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"birthDate\": \"1980-08-16\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"licenseNumber\": \"1234567890\",\n \"licenseState\": \"CA\",\n \"middleName\": \"Alexander\",\n \"suffix\": \"\",\n \"billCode\": \"\",\n \"billReference\": \"\",\n \"purpose\": \"INSURANCE\",\n \"options\": [\n \"LICENSE_VALIDATION\"\n ],\n \"customFields\": [\n {\n \"name\": \"Custom Field\",\n \"value\": \"Custom Value\"\n }\n ],\n \"licenseCategory\": \"LICENSE\",\n \"issueDate\": \"1998-08-16\",\n \"expiryDate\": \"2008-08-16\",\n \"eyeColor\": \"BLACK\",\n \"gender\": \"MALE\",\n \"address\": {\n \"street\": \"495 Grove Street\",\n \"city\": \"Boulder\",\n \"state\": \"CO\",\n \"zipCode\": \"80301\"\n },\n \"height\": 510,\n \"weight\": 195,\n \"activityDuration\": 24\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/orders/v1/mvrreports/activityquote","description":"This endpoint creates a new order for an Activity MVR Report, using the SambaSafety Quote feature.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: application/json
X-Api-Key: [ApiKey]
Parameters:
\npurpose (string, required): The purpose of the order. [\"EMPLOYMENT\", \"INSURANCE\"]
licenseCategory (string, required): The document's category, License Category.
licenseState (string, required): The state jurisdiction issuing the document, US State Abbreviation.
licenseNumber (string, required): The person's family name, as indicated on the document.
birthDate (string, date, required): The person's date of birth.
lastName (string, required): The person's family name, as indicated on the document.
firstName (string, required): The person's given name, as indicated on the document.
middleName (string, optional): The person's middle name or initial, if indicated on the document.
suffix (string, optional): The person's family suffix, Suffix.
address (object, optional): An address object containing:
street (string): The person's mailing street address.
city (string): The person's mailing municipality.
state (string): The person's mailing state, US State Abbreviation.
zipCode (string): The person's mailing postal code.
gender (string, optional): The person's gender, Gender.
height (number, optional): The person's height.
weight (number, optional): The person's weight.
eyeColor (string, optional): The person's eye-color, Eye-Color.
issueDate (string, date, optional): The document's issue date.
expiryDate (string, date, optional): The document's expiration date.
options (Array[string], optional): A list of bundled options. i.e. \"LICENSE_VALIDATION\"
customFields (Array[object], optional): A customer's custom fields.
billCode (string, optional): A customer's custom billing code.
billReference (string, optional): A customer's custom billing reference note.
activityDuration (number, optional): The number of months of activity.
Upon successful request, the API will respond with the a 201 Created containing the order ID.
\nParameters:
\norderId (string, uuid): The order's unique identifier.(Required) The unique identifier of the platform organization
\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"birthDate\": \"1980-08-16\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"licenseNumber\": \"1234567890\",\n \"purpose\": \"INSURANCE\",\n \"licenseState\": \"CA\",\n \"middleName\": \"\",\n \"suffix\": \"\",\n \"billCode\": \"\",\n \"billReference\": \"\",\n \"options\": [\n \"LICENSE_VALIDATION\"\n ],\n \"customFields\": [\n {\n \"name\": \"Custom Field\",\n \"value\": \"Custom Value\"\n }\n ],\n \"licenseCategory\": \"LICENSE\",\n \"issueDate\": \"1998-08-16\",\n \"expiryDate\": \"2008-08-16\",\n \"eyeColor\": \"BLACK\",\n \"gender\": \"MALE\",\n \"address\": {\n \"street\": \"495 Grove Street\",\n \"city\": \"Boulder\",\n \"state\": \"CO\",\n \"zipCode\": \"80301\"\n },\n \"height\": 510,\n \"weight\": 195,\n \"vaultAge\": 30\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/orders/v1/mvrreports/activity","description":"This endpoint creates a new order for an Activity MVR Report, for a single driver.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: application/json
X-Api-Key: [ApiKey]
Parameters:
\npurpose (string, required): The purpose of the order [\"EMPLOYMENT\", \"INSURANCE\"]
licenseCategory (string, required): The document's category \"LICENSE\"
licenseState (string(2), required): The state jurisdiction issuing the document, US State Abbreviation.
licenseNumber (string(30), required): The person's family name, as indicated on the document. License Formats
birthDate (string, date, required): The person's date of birth ISO format (yyyy-MM-dd)
lastName (string(40), required): The person's family name, as indicated on the document
firstName (string(40), required): The person's given name, as indicated on the document
middleName (string(20), optional): The person's middle name or initial, if indicated on the document
suffix (string, optional): The person's family suffix, Suffix - no validation
address (object, optional): An address object containing: - no validation
street (string): The person's mailing street address.
city (string): The person's mailing municipality.
state (string(2)): The person's mailing state, US State Abbreviation.
zipCode (string): The person's mailing postal code. - required IF address is submitted
gender (string, optional): The person's gender, MALE, FEMALE, NON-BINARY
height (number(9), optional): The person's height.
weight (number(9), optional): The person's weight.
eyeColor (string, optional): The person's eye color, BLACK, BLUE, BROWN, DICHROMATIC, GRAY GREEN, OR HAZEL
issueDate (string, date, optional): The document's issue date - no validation
expiryDate (string, date, optional): The document's expiration date - no validation
options (Array[string], optional): A list of bundled options. i.e. \"LICENSE_VALIDATION\"
customFields (Array[object], optional): A customer's custom fields. no validation
billCode (string(100), optional): A customer's custom billing code
billReference (string (250), optional): A customer's custom billing reference note
vaultAge (number(4), optional): Integer value for vault age in days
Values accepted:
0 = no vault allowed
\n1-1095 = days
\nUpon successful request, the API will respond with the a 201 Created containing the order ID.
\nParameters:
\norderId (string, uuid): The order's unique identifier.(Required) The unique identifier of the platform organization
\n"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/orders/v1/mvrreports/activity/:orderId","description":"This endpoint retrieves summary information for the corresponding order ID. The request does not include a request body.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: application/json
X-Api-Key: [ApiKey]
Parameters:
\norderId the unique identifer for the order.Upon successful request, the API will respond with details for the corresponding order. Contains the orderStatus and a links reference to the report, when completed.
\nParameters:
\norderId (string, uuid): The order's unique identifier.
orderStatus (string): The status of the order.
orderDateTime (string, datetime): The timestamp of the order.
orderCompletedDateTime (string, datetime): The timestamp of the order was completed.
controlNumber (string): A SambaSafety identifier for the order.
links (object): An array of links related to the order.
rel (string): The relationship of the link.
href (string): The URL of the link.
type (string): The HTTP Method used to access the link.
id (string): The unique identifier associated with the link.
If you have subscribed to the webhook when the order has been successfully \"fulfilled\", the CallbackURL will be invoked with a \"POST\" and a body containing a url link to the report, and the report uuid.
\nIf an error occurs, the response will have an “error\" event type, with a description of the error.
\nactivitymvr.received
activitymvr.error
Parameters:
\neventId (string, uuid): The callback event's unique identifier.
data (object): The order summary object containing:
orderId (string, uuid): The order's unique identifier.
links (array): An array of links related to the order.
rel (string): The relationship of the link.
href (string): The URL of the link.
type (string): The HTTP Method used to access the link.
id (string): The unique identifier associated with the link.
orderDate (string, datetime): The timestamp of the order.
productOrdered (string): The product ordered (subType).
createdDateTime (string, date): The callback event's timestamp.-
eventType (string): The callback event name.
(Required) The order's unique identifier.
\n","type":"text/plain"},"type":"any","value":"","key":"orderId"}]}},"response":[{"id":"085d9b44-8fba-40d2-83ce-f580fe4a9e3c","name":"200 OK: Status: Fulfilled","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}","description":"(Required) The unique identifier of the platform organization"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer(Required) The unique identifier of the platform organization
\n"},{"key":"Accept","value":"application/vnd.sambasafety.json;version=2.0.4"}],"url":"{{baseUrl}}/reports/v1/mvrreports/activity/:reportId","description":"This endpoint retrieves Activity MVR Report for the corresponding Report ID.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: [Document Version]
X-Api-Key: [ApiKey]
Available Versions:
\napplication/vnd.sambasafety.json;version=3.0.0
\napplication/vnd.sambasafety.json;version=2.0.4
\napplication/vnd.sambasafety.xml;version=2.0.3
\napplication/vnd.sambasafety.xml;version=2.0.2
\napplication/vnd.sambasafety.xml;version=2.0.0
\napplication/vnd.sambasafety.html
\napplication/vnd.sambasafety.pdf ( Base64 Encoded String )
\nParameters:
\nreportId: the unique identifer for the Activity MVR Report.Upon successful request, the API will respond with the Activity MVR for the reportId and report version requested.
Parameters:
\nRecordDlRecordCriteria(object): Contains parameters sent with the request.
OrderDate(object): Contains the date parameters of when the order was placed.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
OrderTime(object): Contains the time parameters of when the order was placed.
Hour(string): The time's hour component [0-23].
Minute(string): The time's minute component [0-59].
Second(string): The time's second component [0-59].
AccountID(string): The account the order was placed under.
UserID(string): The account user who placed the order.
Routing(string): An internal system routing id.
TrackingNumber(string): An internal system tracking number.
Host(string): The internal service identifier.
ProductID(string): The internal product code for the order.
State(object): The license state provided in the request.
Abbrev(string): The state's abbreviation.
Full(string): The state's full name.
Subtype(string): A code indicating a product subtype.
SubtypeFull(string): The full name for the product subtype.
FirstName(string): The first name provided in the request.
LastName(string): The last name provided in the request.
BirthDate(string): The birth date provided in the request.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
OrderLookBackEndDate(string): The look back date determined from the request.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
Result(object): Contains the results of the order.
Control(string): An internal control number for the order.
Valid(string): A [Y,N] indicator that the order was valid.
ErrorCode(string): A code for associated with an error.
ErrorDescription(string): A message describing the result.
ReturnedDate(object): Contains the date parameters of when the order was returned.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ReturnTime(object): Contains the time parameters of when the order was returned.
Hour(string): The time's hour component [0-23].
Minute(string): The time's minute component [0-59].
Second(string): The time's second component [0-59].
ReportPeriod(string): A description of the report period.
CompanyClass(string): A company class code used for custom scoring.
CompanyScore(string): A company score assigned for custom scoring.
IsClear(string): A [Y, N] clear indicator.
IsFromArchive(string): A [Y, N] vault record indicator.
InvoicePath(string): The invoice path.
ResultCode(string): A code for the result.
Driver(object): An object representing the driver.
FirstName(string): The first name of the driver.
MiddleName(string): The middle name of the driver.
LastName(string): The last name of the driver.
SuffixName(string): The suffix name of the driver.
BirthDate(object): Contains the date parameters for the birth date of the driver.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
Age(string): The age of the driver.
EyeColor(string): The eye color of the driver.
HairColor(string): The hair color of the driver.
Weight(string): The weight of the driver.
Height(string): The height of the driver.
Gender(string): The gender of the driver.
Deceased(string): A [Y,N] indicator if the driver is deceased.
TotalStatePoints(string): Total state points as reported by state.
SocialSecurityNumber(string): The driver's social security number.
AddressList(array): An array representing addresses.
Type(string): Address type, usually residence or other.
Street(string): The street address.
City(string): The city where the address is located.
State(string): The state where the address is located.
Abbrev(string): The state's abbreviation.
Full(string): The state's full name.
Zip(string): The postal code for the address.
County(string): The county where the address is located.
AsOfDate(object): Contains the date parameters for the address's as of date.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
AkaList(array): A list of also known as names.
Name(string): AKA name, provided by the state.ConfidenceMatch(string): The confidence score of the discovered driver.
LicenseNumber (string) The drivers license number.
CurrentLicense(object): A report object that contains a drivers active licenses.
Personal(object):
Type(string): Type of license, for example personal, commercial, identification.
ClassDescription(string): Detailed license class description type.
ClassCode(string): The state's license class code.
IssueDate(object): Contains the date parameters of when the license was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the license will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
StatusList(array): A response element contains information on the status of the license.
Name(string): Driver's license status name.
Explanation(string): Additional status information from the state.
EndorsementList(array): An array containing endorsements on the license from the DMV.
Name(string): Driver's license endorsement name.
StartDate(object): Contains the date parameters of when the endorsement was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the endorsement will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
RestrictionList(array): An array containing restrictions on the license from the DMV.
Name(string): Driver's license restriction name.
StartDate(object): Contains the date parameters of when the restriction was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the restriction will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
CertificateList(array): An array containing certificates on the license from the DMV.
Name(string): Driver's license certificate name.
IssueDate(object): Contains the date parameters of when the certificate was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
Commercial(object):
Type(string): Type of license, for example personal, commercial, identification.
ClassDescription(string): Detailed license class description type.
ClassCode(string): The state's license class code.
IssueDate(object): Contains the date parameters of when the license was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the license will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
StatusList(array): A response element contains information on the status of the license.
Name(string): Driver's license status name.
Explanation(string): Additional status information from the state.
EndorsementList(array): An array containing endorsements on the license from the DMV.
Name(string): Driver's license endorsement name.
StartDate(object): Contains the date parameters of when the endorsement was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the endorsement will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
RestrictionList(array): An array containing restrictions on the license from the DMV.
Name(string): Driver's license restriction name.
StartDate(object): Contains the date parameters of when the restriction was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the restriction will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
CertificateList(array): An array containing certificates on the license from the DMV.
Name(string): Driver's license certificate name.
IssueDate(object): Contains the date parameters of when the certificate was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
Motorcycle(object):
Type(string): Type of license, for example personal, commercial, identification.
ClassDescription(string): Detailed license class description type.
ClassCode(string): The state's license class code.
IssueDate(object): Contains the date parameters of when the license was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the license will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
StatusList(array): A response element contains information on the status of the license.
Name(string): Driver's license status name.
Explanation(string): Additional status information from the state.
EndorsementList(array): An array containing endorsements on the license from the DMV.
Name(string): Driver's license endorsement name.
StartDate(object): Contains the date parameters of when the endorsement was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the endorsement will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
RestrictionList(array): An array containing restrictions on the license from the DMV.
Name(string): Driver's license restriction name.
StartDate(object): Contains the date parameters of when the restriction was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the restriction will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
CertificateList(array): An array containing certificates on the license from the DMV.
Name(string): Driver's license certificate name.
IssueDate(object): Contains the date parameters of when the certificate was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
Identification(object):
Type(string): Type of license, for example personal, commercial, identification.
ClassDescription(string): Detailed license class description type.
ClassCode(string): The state's license class code.
IssueDate(object): Contains the date parameters of when the license was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the license will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
StatusList(array): A response element contains information on the status of the license.
Name(string): Driver's license status name.
Explanation(string): Additional status information from the state.
EndorsementList(array): An array containing endorsements on the license from the DMV.
Name(string): Driver's license endorsement name.
StartDate(object): Contains the date parameters of when the endorsement was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the endorsement will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
RestrictionList(array): An array containing restrictions on the license from the DMV.
Name(string): Driver's license restriction name.
StartDate(object): Contains the date parameters of when the restriction was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the restriction will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
CertificateList(array): An array containing certificates on the license from the DMV.
Name(string): Driver's license certificate name.
IssueDate(object): Contains the date parameters of when the certificate was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
Number(string): The current license number.
ContrivedOriginalIssueYear(string): Contains a calculated original issue year of the current license.
ExactOriginalIssueDate(object): Contains the date parameters for the original issue date of the current license.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
LicenseHistoryList(array): A report object that contains a drivers historic licenses.
Type(string): Type of license, for example personal, commercial, identification.
ClassDescription(string): Detailed license class description type.
ClassCode(string): The state's license class code.
IssueDate(object): Contains the date parameters of when the license was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the license will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
StatusList(array): A response element contains information on the status of the license.
Name(string): Driver's license status name.
Explanation(string): Additional status information from the state.
EndorsementList(array): An array containing endorsements on the license from the DMV.
Name(string): Driver's license endorsement name.
StartDate(object): Contains the date parameters of when the endorsement was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the endorsement will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
RestrictionList(array): An array containing restrictions on the license from the DMV.
Name(string): Driver's license restriction name.
StartDate(object): Contains the date parameters of when the restriction was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the restriction will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
MedicalCertificateList(array): An array containing CDL Medical Certificate details.
Status(string): The status [Certified/Not Certified]
StatusRaw(string); The status description from the DMV.
IssueDate(object): Contains the date parameters of when the medical certificate was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the medical certificate will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
WasReceived(string): A [Y/N] indicates the medical certificate was received by DMV.
DowngradedDate(object): Contains the date parameters of when the medical certificate was downgraded.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
DowngradedEndDate(object): Contains the date parameters of when the medical certificate's downgrade will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
DowngradedReason(string): The reason for the medical certificate downgrade.
DowngradedDescription(string): The description for the medical certificate downgrade.
AdditionalList(array): A list of additional items.
AdditionalItem(string): An additional item of medical certificate information.RestrictionList(array): A list of medical certificate restrictions.
Description(string): The normalized description of the restriction.
DescriptionRaw(string): The medical certificate's restriction description from the DMV.
Examiner(string): The medical examiner issuing the certificate.
First(string): The medical examiner's first name.
Middle(string): The medical examiner's middle name.
Last(string): The medical examiner's last name.
Suffix(string): The medical examiner's suffix name.
License(string): The medical examiner's license number.
LicenseState(string): The state where the medical examiner's is licensed.
Abbrev(string): The state's abbreviation.
Full(string): The state's full name.
RegistrationNumber(string): The medical examiner's registration number.
Phone(string): The medical examiner's phone number.
SpecialtyDescription(string): The medical examiner's speciality description.
SpecialtyRaw(string): The medical examiner's speciality description from the DMV.
VarianceList(array): A list of variance items.
Type(object): The type medical certificate variance.
IssuedDate(object): Contains the date parameters of when the medical certificate's variance was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the medical certificate's variance will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
RescindedDate(object): Contains the date parameters of when the medical certificate's variance was rescinded.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
SelfCertification(object): Contains the CDL Self Certification on file with the DMV.
EffectiveDate(object): Contains the date parameters of self-certification effective date.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
Type(string): The type of self-certification.
TypeCode(string): The type code for the self-certification.
FinancialResponsibilityList(array): A list of financial responsibility requirements of the driver.
Type(string): The type of financial responsibility.
Description(string): The description of financial responsibility.
FiledDate(string): The filing date of the financial responsibility.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(string): The expiration date of the financial responsibility.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
EffectiveDate(string): The effective date of the financial responsibility.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ProofRequiredDate(string): The proof required date of the financial responsibility.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ProofEndDate(string): The proof end date of the financial responsibility.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
PolicyNumber(string): The financial responsibility policy number.
InsuranceCompanyNaic(string): The financial responsibility insurance company's NAIC number.
InsuranceCompanyName(string): The financial responsibility insurance company's name.
DocketNumber(string): The docket number resulting in financial responsibility.
IsAlcoholDrugProgramRequired(string): Does the financial responsibility require an substance abuse program.
PreviousLicenseList(string): A list containing non-current driver's license information.
Class(string): The class of license.
Number(string): The license number.
State(object): The license state.
Abbrev(string): The state's abbreviation.
Full(string): The state's full name.
SentenceList(string): A list containing details on court sentencing.
DocketNumber(string): The docket number for the sentencing.
State(object): The state jurisdiction of the sentencing.
Abbrev(string): The state's abbreviation.
Full(string): The state's full name.
StateDescription(string): The state's description.
TerminationDate(string): The termination date of the sentencing.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ViolationDate(string): The violation date of the sentencing.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
MessageList(array): A list of messages returned as part of the report.
Line(string): A message line.EventList(array): A list of events returned as part of the report.
Common(object): A set of common parameters for the event.
Subtype(string): A subtype of event.
State(object): The state where the event occurred.
Abbrev(string): The state's abbreviation.
Full(string): The state's full name.
Date(object): The date the event occurred.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
PostedDate(object): The date the event was posted.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ModifiedDate(object): The date the event was last modified.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
Location(string): The location where the event occurred.
LocationCode(string): The location code where the event occurred.
IsHazMat(string): An indicator the event included HazMat.
IsCommercial(string): An indicator the event included a commercial vehicle.
DocketNumber(string): The event's docket number.
Plate(string): The vehicle's plate number.
NoteList(array): of notes associated with the event.
Note(string): The note text.DescriptionList(array): of descriptions associated with the event.
AdrLargeDescription(string): A normalized full description of the event.
AdrSmallDescription(string): A normalized summary of the event.
StateDescription(string): The state's description of the event.
StateCode(string): The state's code for the event.
Acd(string): A standardized code for the event.
Avd1(string): A SambaSafety standardized code for the event.
Avd2(string): A SambaSafety standardized code for the event.
Avd3(string): A SambaSafety standardized code for the event.
CompanyCode(string): The customer code assigned to the event.
CompanyPoints(string): the customer points assigned to the event.
StateAssignedPoints(string): The state assigned points to the event.
TableKey(string): A SambaSafety event mapping key.
Violation(object): An object representing the violation details.
ConvictionDate(object): The conviction date the violation.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ActualSpeed(string): The actual speed driver was traveling.
PostedSpeed(string): The road's posted speed limit.
Statute(string): The state's legal statute for the violation.
CourtType(string): The type of court.
DismissalCode(string): The court's dismissal code.
DismissalDate(object): The dismissal date the violation.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
Disposition(string): The court's disposition result, guilty or not guilty.
BloodAlcoholLevel(string): The BAC level reported with the violation.
AmendedConsentDate(object): An amended consent date.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ConsentDate(object): The consent date.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
HasFailureToPayFine(string): A [Y/N] indicator that the driver failed to pay the fine.
FineAmount(string): The amount of the fine.
JudgeName(string): The name of the judge.
IsAssociatedWithSuspension(string): A [Y/N] indicates a suspension with the violation.
IsAssociatedWithAccident(string): A [Y/N] indicates an accident with the violation.
HasAccidentFatality(string): A [Y/N] indicates a fatality occurred during the accident.
HasAccidentInjury(string): A [Y/N] indicates an injury occurred during the accident.
Accident(object): An object representing an accident details.
IsInjuryAccident(string): A [Y/N] indicates an injury occurred during the accident.
IsAtFault(string): A [Y/N] indicates the driver is at fault for the accident.
IsFatalityAccident(string): A [Y/N] indicates a fatality occurred during the accident.
FrPolicyNumber(string): The insurance policy number associated with the accident.
VehiclesInvolvedCount(string): The number of vehicles involved in accident.
IsReportFiled(string): A [Y/N] indicates if an accident report was filed.
ReportNumber(string): The accident report number.
FrFileNumber(string): The insurance policy file/claim number.
AccidentFatalityCount(string): The number of fatalities in accident.
AccidentInjuryCount(string): The number of injuries in accident.
Action(object): An object representing an action details.
PrivilegeReinstatementDate(object): The date when driving privileges are reinstated.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ActualDate(object): The actual date of the action.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ClearDate(object): The clear date of the action.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ActionEndDate(object): The action's end date.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ArrestDate(object): An arrest date associated with the action.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
MailDate(object): A mail date associated with the action.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
OffenseDate(object): The date of the offense.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
Extent(string): Identifies the extent of lost driving privileges.
JudgeName(string): The name of the judge.
LengthInMonths(string): The action's length in months.
AdditionalDescription(string): Additional information form the state regarding the action.
CurrentStatus(string): The status of the action.
FailureToAppear(object): An object representing a failure to appear in court.
AmountDue(sting): The fine amount due.
BloodAlcoholLevel(string): The BAC level reported with the violation.
JudgeName(string): The name of the judge.
IsWarrantIssued(string): A [Y/N] indicates if a warrant was issued for FTA.
AdjudicatedAndWithdrawals(object): An object contains details about adjudications.
IsAssociatedWithAccident(object): A [Y/N] indicates an accident was involved.
ConvictionDate(object): The date of the conviction.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
CourtType(string): The type of court.
Disposition(string): The court's disposition result, guilty or not guilty.
ActualSpeed(string): The actual speed driver was traveling.
PostedSpeed(string): The road's posted speed limit.
(Required) A report's unique identifier.
\n","type":"text/plain"},"type":"any","value":"","key":"reportId"}]}},"response":[{"id":"15413e09-1124-489e-a412-c983183b6ca1","name":"200 OK: Activity Triggered, Version=3.0.0","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}","description":"(Required) The unique identifier of the platform organization"},{"key":"Accept","value":"application/vnd.sambasafety.json;version=2.0.4"},{"key":"Authorization","value":"BearerThe Activity MVR service will attempt to return a historical MVR if one is available. The system will check state activity or court data for new activity.
\nIf no new activity is found AND no historical MVR is available, it will return a Clean Stub.
\nIf activity is found, then an MVR is ordered.
\nAuthentication: Obtain a token to gain access
\nPlace an Order: Place an order to get data for the person
\nCheck Order Status: Check whether an order that has been placed has been fulfilled
\nGet a Report: Get the data ordered
\nFor more information on Activity MVR visit our SambaSafety Knowledge Base
\n","_postman_id":"e31761d9-eefc-47e0-8ea8-f6d513d1db38","auth":{"type":"apikey","apikey":{"key":"(Required) The unique identifier of the platform organization
\n"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/orders/v1/mvrreports/intelligent?page=1&size=50&startOrderDate=2023-01-01&endOrderDate=2023-09-15","description":"This endpoint retrieves list of previouss orders placed for the Service. The request does not include a request body. Upon successful request, the API will respond with a list of previously placed orders, including the current order status.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: application/json
X-Api-Key: [ApiKey]
Parameters:
\npage:the page of transactions to review. Default value: 1
size:the number of transactions to review on a page. Default value:25
startOrderDate: Start date when orders were created. If value is not provided, search will default to midnight (00:00:00 a.m.) of previous day.
endOrderDate Inclusive end date when orders were created. If value is not provided, search will default to end of day (23:59:59 p.m.).
Parameters:
\ndata
errorMessage (string): An error message attached to the order.
orderId (string, uuid): The license's unique identifier.
status (string): The enrollment type.
request (object): The order request object from Place an Order.
createdDateTime (string, datetime): The timestamp of the order.
meta
totalPages (number): The total number of pages.
totalRecords (number): The total number of records.
links
self (string, url): The URL to the current page.
first (string, url): The URL to the first page of data.
next (string, url): The URL to the next page of data.
prev (string, url): The URL to the previous page of data.
last (string, url): The URL to the last page of data.
The page of data being displayed.
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"The number of items on a page.
\n","type":"text/plain"},"key":"size","value":"50"},{"description":{"content":"Start date when orders were created. If value is not provided, search will default to midnight (00:00:00 a.m.) of previous day.
\nPattern: yyyy-MM-dd
\n","type":"text/plain"},"key":"startOrderDate","value":"2023-01-01"},{"description":{"content":"Inclusive end date when orders were created. If value is not provided, search will default to end of day (23:59:59 p.m.).
\nPattern: yyyy-MM-dd
\n","type":"text/plain"},"key":"endOrderDate","value":"2023-09-15"}],"variable":[]}},"response":[{"id":"8eda9f35-909c-4932-b44f-379e6cf7daad","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}","description":"(Required) The unique identifier of the platform organization"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer(Required) The unique identifier of the platform organization
\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"birthDate\": \"1980-08-16\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"licenseNumber\": \"201805113\",\n \"purpose\": \"INSURANCE\",\n \"licenseState\": \"SC\",\n \"middleName\": \"\",\n \"suffix\": \"\",\n \"billCode\": \"\",\n \"billReference\": \"\",\n \"options\": [\n \"LICENSE_VALIDATION\"\n ],\n \"customFields\": [\n {\n \"name\": \"Custom Field\",\n \"value\": \"Custom Value\"\n }\n ],\n \"licenseCategory\": \"LICENSE\",\n \"issueDate\": \"1998-08-16\",\n \"expiryDate\": \"2008-08-16\",\n \"eyeColor\": \"BLACK\",\n \"gender\": \"MALE\",\n \"address\": {\n \"street\": \"495 Grove Street\",\n \"city\": \"Boulder\",\n \"state\": \"CO\",\n \"zipCode\": \"80301\"\n },\n \"height\": 510,\n \"weight\": 195,\n \"vaultAge\": 30\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/orders/v1/mvrreports/intelligent","description":"This endpoint creates a new order for an Intelligent MVR Report, for a single driver.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: application/json
X-Api-Key: [ApiKey]
Parameters:
\npurpose (string, required): The purpose of the order. [\"EMPLOYMENT\", \"INSURANCE\"]
licenseCategory (string, required): The document's category, License Category.
licenseState (string, required): The state jurisdiction issuing the document, US State Abbreviation.
licenseNumber (string, required): The person's family name, as indicated on the document.
birthDate (string, date, required): The person's date of birth.
lastName (string, required): The person's family name, as indicated on the document.
firstName (string, required): The person's given name, as indicated on the document.
middleName (string, optional): The person's middle name or initial, if indicated on the document.
suffix (string, optional): The person's family suffix, Suffix.
address (object, optional): An address object containing:
street (string): The person's mailing street address.
city (string): The person's mailing municipality.
state (string): The person's mailing state, US State Abbreviation.
zipCode (string): The person's mailing postal code.
gender (string, optional): The person's gender, Gender.
height (number, optional): The person's height.
weight (number, optional): The person's weight.
eyeColor (string, optional): The person's eye-color, Eye-Color.
issueDate (string, date, optional): The document's issue date.
expiryDate (string, date, optional): The document's expiration date.
options (Array[string], optional): A list of bundled options. i.e. \"LICENSE_VALIDATION\"
customFields (Array[object], optional): A customer's custom fields.
billCode (string, optional): A customer's custom billing code.
billReference (string, optional): A customer's custom billing reference note.
vaultAge (number, optional): Integer value for vault age in days.
Values accepted:
0 = no vault allowed
\n1-1095 = days
\nUpon successful request, the API will respond with the a 201 Created containing the order ID.
\nParameters:
\norderId (string, uuid): The order's unique identifier.(Required) The unique identifier of the platform organization
\n"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/orders/v1/mvrreports/intelligent/:orderId","description":"This endpoint retrieves summary information for the corresponding order ID. The request does not include a request body.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: application/json
X-Api-Key: [ApiKey]
Parameters:
\norderId the unique identifer for the order.Upon successful request, the API will respond with details for the corresponding order. Contains the orderStatus and a links reference to the report, when completed.
\nParameters:
\norderId (string, uuid): The order's unique identifier.
orderStatus (string): The status of the order.
orderDateTime (string, datetime): The timestamp of the order.
orderCompletedDateTime (string, datetime): The timestamp of the order was completed.
controlNumber (string): A SambaSafety identifier for the order.
links (object): An array of links related to the order.
rel (string): The relationship of the link.
href (string): The URL of the link.
type (string): The HTTP Method used to access the link.
id (string): The unique identifier associated with the link.
If you have subscribed to the webhook when the order has been successfully \"fulfilled\", the CallbackURL will be invoked with a \"POST\" and a body containing a url link to the report, and the report uuid.
\nIf an error occurs, the response will have an “error\" event type, with a description of the error.
\nintelligentmvr.received
intelligentmvr.error
Parameters:
\neventId (string, uuid): The callback event's unique identifier.
data (object): The order summary object containing:
orderId (string, uuid): The order's unique identifier.
links (array): An array of links related to the order.
rel (string): The relationship of the link.
href (string): The URL of the link.
type (string): The HTTP Method used to access the link.
id (string): The unique identifier associated with the link.
orderDate (string, datetime): The timestamp of the order.
productOrdered (string): The product ordered (subType).
createdDateTime (string, date): The callback event's timestamp.-
eventType (string): The callback event name.
(Required) The order's unique identifier.
\n","type":"text/plain"},"type":"any","value":"","key":"orderId"}]}},"response":[{"id":"8f24cfae-4874-4181-8ef2-26eb19a58c9c","name":"200 OK: Status: Fulfilled","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}","description":"(Required) The unique identifier of the platform organization"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer(Required) The unique identifier of the platform organization
\n"},{"key":"Accept","value":"application/vnd.sambasafety.json;version=2.0.4"}],"url":"{{baseUrl}}/reports/v1/mvrreports/intelligent/:reportId","description":"This endpoint retrieves Intelligent MVR Report for the corresponding Report ID.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: [Document Version]
X-Api-Key: [ApiKey]
Available Versions:
\napplication/vnd.sambasafety.json;version=3.0.0
\napplication/vnd.sambasafety.json;version=2.0.4
\napplication/vnd.sambasafety.xml;version=2.0.3
\napplication/vnd.sambasafety.xml;version=2.0.2
\napplication/vnd.sambasafety.xml;version=2.0.0
\napplication/vnd.sambasafety.html
\napplication/vnd.sambasafety.pdf ( Base64 Encoded String )
\nParameters:
\nreportId: the unique identifer for the Intelligent MVR Report.Upon successful request, the API will respond with the Intelligent MVR for the reportId and report version requested.
Parameters:
\nRecordDlRecordCriteria(object): Contains parameters sent with the request.
OrderDate(object): Contains the date parameters of when the order was placed.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
OrderTime(object): Contains the time parameters of when the order was placed.
Hour(string): The time's hour component [0-23].
Minute(string): The time's minute component [0-59].
Second(string): The time's second component [0-59].
AccountID(string): The account the order was placed under.
UserID(string): The account user who placed the order.
Routing(string): An internal system routing id.
TrackingNumber(string): An internal system tracking number.
Host(string): The internal service identifier.
ProductID(string): The internal product code for the order.
State(object): The license state provided in the request.
Abbrev(string): The state's abbreviation.
Full(string): The state's full name.
Subtype(string): A code indicating a product subtype.
SubtypeFull(string): The full name for the product subtype.
FirstName(string): The first name provided in the request.
LastName(string): The last name provided in the request.
BirthDate(string): The birth date provided in the request.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
OrderLookBackEndDate(string): The look back date determined from the request.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
Result(object): Contains the results of the order.
Control(string): An internal control number for the order.
Valid(string): A [Y,N] indicator that the order was valid.
ErrorCode(string): A code for associated with an error.
ErrorDescription(string): A message describing the result.
ReturnedDate(object): Contains the date parameters of when the order was returned.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ReturnTime(object): Contains the time parameters of when the order was returned.
Hour(string): The time's hour component [0-23].
Minute(string): The time's minute component [0-59].
Second(string): The time's second component [0-59].
ReportPeriod(string): A description of the report period.
CompanyClass(string): A company class code used for custom scoring.
CompanyScore(string): A company score assigned for custom scoring.
IsClear(string): A [Y, N] clear indicator.
IsFromArchive(string): A [Y, N] vault record indicator.
InvoicePath(string): The invoice path.
ResultCode(string): A code for the result.
Driver(object): An object representing the driver.
FirstName(string): The first name of the driver.
MiddleName(string): The middle name of the driver.
LastName(string): The last name of the driver.
SuffixName(string): The suffix name of the driver.
BirthDate(object): Contains the date parameters for the birth date of the driver.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
Age(string): The age of the driver.
EyeColor(string): The eye color of the driver.
HairColor(string): The hair color of the driver.
Weight(string): The weight of the driver.
Height(string): The height of the driver.
Gender(string): The gender of the driver.
Deceased(string): A [Y,N] indicator if the driver is deceased.
TotalStatePoints(string): Total state points as reported by state.
SocialSecurityNumber(string): The driver's social security number.
AddressList(array): An array representing addresses.
Type(string): Address type, usually residence or other.
Street(string): The street address.
City(string): The city where the address is located.
State(string): The state where the address is located.
Abbrev(string): The state's abbreviation.
Full(string): The state's full name.
Zip(string): The postal code for the address.
County(string): The county where the address is located.
AsOfDate(object): Contains the date parameters for the address's as of date.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
AkaList(array): A list of also known as names.
Name(string): AKA name, provided by the state.ConfidenceMatch(string): The confidence score of the discovered driver.
LicenseNumber (string) The drivers license number.
CurrentLicense(object): A report object that contains a drivers active licenses.
Personal(object):
Type(string): Type of license, for example personal, commercial, identification.
ClassDescription(string): Detailed license class description type.
ClassCode(string): The state's license class code.
IssueDate(object): Contains the date parameters of when the license was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the license will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
StatusList(array): A response element contains information on the status of the license.
Name(string): Driver's license status name.
Explanation(string): Additional status information from the state.
EndorsementList(array): An array containing endorsements on the license from the DMV.
Name(string): Driver's license endorsement name.
StartDate(object): Contains the date parameters of when the endorsement was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the endorsement will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
RestrictionList(array): An array containing restrictions on the license from the DMV.
Name(string): Driver's license restriction name.
StartDate(object): Contains the date parameters of when the restriction was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the restriction will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
CertificateList(array): An array containing certificates on the license from the DMV.
Name(string): Driver's license certificate name.
IssueDate(object): Contains the date parameters of when the certificate was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
Commercial(object):
Type(string): Type of license, for example personal, commercial, identification.
ClassDescription(string): Detailed license class description type.
ClassCode(string): The state's license class code.
IssueDate(object): Contains the date parameters of when the license was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the license will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
StatusList(array): A response element contains information on the status of the license.
Name(string): Driver's license status name.
Explanation(string): Additional status information from the state.
EndorsementList(array): An array containing endorsements on the license from the DMV.
Name(string): Driver's license endorsement name.
StartDate(object): Contains the date parameters of when the endorsement was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the endorsement will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
RestrictionList(array): An array containing restrictions on the license from the DMV.
Name(string): Driver's license restriction name.
StartDate(object): Contains the date parameters of when the restriction was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the restriction will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
CertificateList(array): An array containing certificates on the license from the DMV.
Name(string): Driver's license certificate name.
IssueDate(object): Contains the date parameters of when the certificate was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
Motorcycle(object):
Type(string): Type of license, for example personal, commercial, identification.
ClassDescription(string): Detailed license class description type.
ClassCode(string): The state's license class code.
IssueDate(object): Contains the date parameters of when the license was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the license will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
StatusList(array): A response element contains information on the status of the license.
Name(string): Driver's license status name.
Explanation(string): Additional status information from the state.
EndorsementList(array): An array containing endorsements on the license from the DMV.
Name(string): Driver's license endorsement name.
StartDate(object): Contains the date parameters of when the endorsement was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the endorsement will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
RestrictionList(array): An array containing restrictions on the license from the DMV.
Name(string): Driver's license restriction name.
StartDate(object): Contains the date parameters of when the restriction was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the restriction will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
CertificateList(array): An array containing certificates on the license from the DMV.
Name(string): Driver's license certificate name.
IssueDate(object): Contains the date parameters of when the certificate was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
Identification(object):
Type(string): Type of license, for example personal, commercial, identification.
ClassDescription(string): Detailed license class description type.
ClassCode(string): The state's license class code.
IssueDate(object): Contains the date parameters of when the license was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the license will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
StatusList(array): A response element contains information on the status of the license.
Name(string): Driver's license status name.
Explanation(string): Additional status information from the state.
EndorsementList(array): An array containing endorsements on the license from the DMV.
Name(string): Driver's license endorsement name.
StartDate(object): Contains the date parameters of when the endorsement was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the endorsement will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
RestrictionList(array): An array containing restrictions on the license from the DMV.
Name(string): Driver's license restriction name.
StartDate(object): Contains the date parameters of when the restriction was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the restriction will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
CertificateList(array): An array containing certificates on the license from the DMV.
Name(string): Driver's license certificate name.
IssueDate(object): Contains the date parameters of when the certificate was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
Number(string): The current license number.
ContrivedOriginalIssueYear(string): Contains a calculated original issue year of the current license.
ExactOriginalIssueDate(object): Contains the date parameters for the original issue date of the current license.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
LicenseHistoryList(array): A report object that contains a drivers historic licenses.
Type(string): Type of license, for example personal, commercial, identification.
ClassDescription(string): Detailed license class description type.
ClassCode(string): The state's license class code.
IssueDate(object): Contains the date parameters of when the license was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the license will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
StatusList(array): A response element contains information on the status of the license.
Name(string): Driver's license status name.
Explanation(string): Additional status information from the state.
EndorsementList(array): An array containing endorsements on the license from the DMV.
Name(string): Driver's license endorsement name.
StartDate(object): Contains the date parameters of when the endorsement was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the endorsement will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
RestrictionList(array): An array containing restrictions on the license from the DMV.
Name(string): Driver's license restriction name.
StartDate(object): Contains the date parameters of when the restriction was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the restriction will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
MedicalCertificateList(array): An array containing CDL Medical Certificate details.
Status(string): The status [Certified/Not Certified]
StatusRaw(string); The status description from the DMV.
IssueDate(object): Contains the date parameters of when the medical certificate was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the medical certificate will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
WasReceived(string): A [Y/N] indicates the medical certificate was received by DMV.
DowngradedDate(object): Contains the date parameters of when the medical certificate was downgraded.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
DowngradedEndDate(object): Contains the date parameters of when the medical certificate's downgrade will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
DowngradedReason(string): The reason for the medical certificate downgrade.
DowngradedDescription(string): The description for the medical certificate downgrade.
AdditionalList(array): A list of additional items.
AdditionalItem(string): An additional item of medical certificate information.RestrictionList(array): A list of medical certificate restrictions.
Description(string): The normalized description of the restriction.
DescriptionRaw(string): The medical certificate's restriction description from the DMV.
Examiner(string): The medical examiner issuing the certificate.
First(string): The medical examiner's first name.
Middle(string): The medical examiner's middle name.
Last(string): The medical examiner's last name.
Suffix(string): The medical examiner's suffix name.
License(string): The medical examiner's license number.
LicenseState(string): The state where the medical examiner's is licensed.
Abbrev(string): The state's abbreviation.
Full(string): The state's full name.
RegistrationNumber(string): The medical examiner's registration number.
Phone(string): The medical examiner's phone number.
SpecialtyDescription(string): The medical examiner's speciality description.
SpecialtyRaw(string): The medical examiner's speciality description from the DMV.
VarianceList(array): A list of variance items.
Type(object): The type medical certificate variance.
IssuedDate(object): Contains the date parameters of when the medical certificate's variance was issued.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(object): Contains the date parameters of when the medical certificate's variance will expire.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
RescindedDate(object): Contains the date parameters of when the medical certificate's variance was rescinded.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
SelfCertification(object): Contains the CDL Self Certification on file with the DMV.
EffectiveDate(object): Contains the date parameters of self-certification effective date.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
Type(string): The type of self-certification.
TypeCode(string): The type code for the self-certification.
FinancialResponsibilityList(array): A list of financial responsibility requirements of the driver.
Type(string): The type of financial responsibility.
Description(string): The description of financial responsibility.
FiledDate(string): The filing date of the financial responsibility.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ExpirationDate(string): The expiration date of the financial responsibility.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
EffectiveDate(string): The effective date of the financial responsibility.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ProofRequiredDate(string): The proof required date of the financial responsibility.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ProofEndDate(string): The proof end date of the financial responsibility.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
PolicyNumber(string): The financial responsibility policy number.
InsuranceCompanyNaic(string): The financial responsibility insurance company's NAIC number.
InsuranceCompanyName(string): The financial responsibility insurance company's name.
DocketNumber(string): The docket number resulting in financial responsibility.
IsAlcoholDrugProgramRequired(string): Does the financial responsibility require an substance abuse program.
PreviousLicenseList(string): A list containing non-current driver's license information.
Class(string): The class of license.
Number(string): The license number.
State(object): The license state.
Abbrev(string): The state's abbreviation.
Full(string): The state's full name.
SentenceList(string): A list containing details on court sentencing.
DocketNumber(string): The docket number for the sentencing.
State(object): The state jurisdiction of the sentencing.
Abbrev(string): The state's abbreviation.
Full(string): The state's full name.
StateDescription(string): The state's description.
TerminationDate(string): The termination date of the sentencing.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ViolationDate(string): The violation date of the sentencing.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
MessageList(array): A list of messages returned as part of the report.
Line(string): A message line.EventList(array): A list of events returned as part of the report.
Common(object): A set of common parameters for the event.
Subtype(string): A subtype of event.
State(object): The state where the event occurred.
Abbrev(string): The state's abbreviation.
Full(string): The state's full name.
Date(object): The date the event occurred.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
PostedDate(object): The date the event was posted.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ModifiedDate(object): The date the event was last modified.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
Location(string): The location where the event occurred.
LocationCode(string): The location code where the event occurred.
IsHazMat(string): An indicator the event included HazMat.
IsCommercial(string): An indicator the event included a commercial vehicle.
DocketNumber(string): The event's docket number.
Plate(string): The vehicle's plate number.
NoteList(array): of notes associated with the event.
Note(string): The note text.DescriptionList(array): of descriptions associated with the event.
AdrLargeDescription(string): A normalized full description of the event.
AdrSmallDescription(string): A normalized summary of the event.
StateDescription(string): The state's description of the event.
StateCode(string): The state's code for the event.
Acd(string): A standardized code for the event.
Avd1(string): A SambaSafety standardized code for the event.
Avd2(string): A SambaSafety standardized code for the event.
Avd3(string): A SambaSafety standardized code for the event.
CompanyCode(string): The customer code assigned to the event.
CompanyPoints(string): the customer points assigned to the event.
StateAssignedPoints(string): The state assigned points to the event.
TableKey(string): A SambaSafety event mapping key.
Violation(object): An object representing the violation details.
ConvictionDate(object): The conviction date the violation.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ActualSpeed(string): The actual speed driver was traveling.
PostedSpeed(string): The road's posted speed limit.
Statute(string): The state's legal statute for the violation.
CourtType(string): The type of court.
DismissalCode(string): The court's dismissal code.
DismissalDate(object): The dismissal date the violation.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
Disposition(string): The court's disposition result, guilty or not guilty.
BloodAlcoholLevel(string): The BAC level reported with the violation.
AmendedConsentDate(object): An amended consent date.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ConsentDate(object): The consent date.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
HasFailureToPayFine(string): A [Y/N] indicator that the driver failed to pay the fine.
FineAmount(string): The amount of the fine.
JudgeName(string): The name of the judge.
IsAssociatedWithSuspension(string): A [Y/N] indicates a suspension with the violation.
IsAssociatedWithAccident(string): A [Y/N] indicates an accident with the violation.
HasAccidentFatality(string): A [Y/N] indicates a fatality occurred during the accident.
HasAccidentInjury(string): A [Y/N] indicates an injury occurred during the accident.
Accident(object): An object representing an accident details.
IsInjuryAccident(string): A [Y/N] indicates an injury occurred during the accident.
IsAtFault(string): A [Y/N] indicates the driver is at fault for the accident.
IsFatalityAccident(string): A [Y/N] indicates a fatality occurred during the accident.
FrPolicyNumber(string): The insurance policy number associated with the accident.
VehiclesInvolvedCount(string): The number of vehicles involved in accident.
IsReportFiled(string): A [Y/N] indicates if an accident report was filed.
ReportNumber(string): The accident report number.
FrFileNumber(string): The insurance policy file/claim number.
AccidentFatalityCount(string): The number of fatalities in accident.
AccidentInjuryCount(string): The number of injuries in accident.
Action(object): An object representing an action details.
PrivilegeReinstatementDate(object): The date when driving privileges are reinstated.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ActualDate(object): The actual date of the action.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ClearDate(object): The clear date of the action.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ActionEndDate(object): The action's end date.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
ArrestDate(object): An arrest date associated with the action.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
MailDate(object): A mail date associated with the action.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
OffenseDate(object): The date of the offense.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
Extent(string): Identifies the extent of lost driving privileges.
JudgeName(string): The name of the judge.
LengthInMonths(string): The action's length in months.
AdditionalDescription(string): Additional information form the state regarding the action.
CurrentStatus(string): The status of the action.
FailureToAppear(object): An object representing a failure to appear in court.
AmountDue(sting): The fine amount due.
BloodAlcoholLevel(string): The BAC level reported with the violation.
JudgeName(string): The name of the judge.
IsWarrantIssued(string): A [Y/N] indicates if a warrant was issued for FTA.
AdjudicatedAndWithdrawals(object): An object contains details about adjudications.
IsAssociatedWithAccident(object): A [Y/N] indicates an accident was involved.
ConvictionDate(object): The date of the conviction.
Year(number): The date's year component.
Month(number): The date's month component.
Day(number): The date's day component.
Full(string): The date in string format.
Ticks(number): The date's numeric equivalent.
CourtType(string): The type of court.
Disposition(string): The court's disposition result, guilty or not guilty.
ActualSpeed(string): The actual speed driver was traveling.
PostedSpeed(string): The road's posted speed limit.
(Required) A report's unique identifier.
\n","type":"text/plain"},"type":"any","value":"","key":"reportId"}]}},"response":[{"id":"56d63187-2017-4260-9715-1c392c6ad2ea","name":"200 OK: Baseline Version=3.0.0","originalRequest":{"method":"GET","header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"controlNumber\": \"08230N\",\n \"mvrDateTime\": \"2024-02-26T13:32:00-08:00\",\n \"mvrScoring\": {\n \"companyClass\": \"CLEAR\",\n \"companyScore\": \"0\"\n },\n \"mvrOrder\": {\n \"orderDateTime\": \"2024-02-26T13:32:00-08:00\",\n \"person\": {\n \"firstName\": \"JOHN\",\n \"middleName\": \"LLLL\",\n \"lastName\": \"DOE\",\n \"birthDate\": \"1980-08-16\"\n },\n \"license\": {\n \"licenseNumber\": \"201805113\",\n \"licenseState\": \"SC\"\n }\n },\n \"mvrDriver\": {\n \"person\": {\n \"firstName\": \"JOHN\",\n \"middleName\": \"LLLL\",\n \"lastName\": \"DOE\",\n \"suffixName\": \"JR\"\n },\n \"license\": {\n \"licenseNumber\": \"201805113\",\n \"licenseState\": \"SC\"\n },\n \"exactOriginalIssueDate\": \"1996-01-29\",\n \"hasDriverTraining\": \"N\",\n \"totalStatePoints\": \"0\"\n },\n \"licenseClasses\": {\n \"personal\": {\n \"license\": {\n \"classDescription\": \"ALL NON-COMMERCIAL VEH < 26K (EXCEPT MOTORCYCLE)\",\n \"classCode\": \"D\",\n \"issueDate\": \"2016-02-22\",\n \"expirationDate\": \"2026-02-21\",\n \"statusList\": [\n {\n \"name\": \"VALID\",\n \"explanation\": \"NO SUSPENSION\"\n }\n ]\n }\n },\n \"commercial\": {\n \"license\": {\n \"classDescription\": \"COMBINE VEH > 25K W/TRAILER > 10K\",\n \"classCode\": \"A\",\n \"issueDate\": \"2017-04-11\",\n \"expirationDate\": \"2022-02-21\",\n \"hasDriverTraining\": \"N\",\n \"statusList\": [\n {\n \"name\": \"VALID\",\n \"explanation\": \"NO DISQUALIFICATION\"\n }\n ],\n \"endorsements\": [\n {\n \"description\": \"TANKS\"\n }\n ]\n }\n }\n },\n \"mvrMedicalCertificate\": {\n \"status\": \"CERTIFIED\",\n \"expirationDate\": \"2021-01-11\",\n \"issueDate\": \"2017-01-11\",\n \"examiner\": {\n \"firstName\": \"LILLIAN\",\n \"lastName\": \"STUKES\",\n \"medicalExaminerLicense\": \"18215\",\n \"medicalExaminerLicenseState\": \"SC\",\n \"registrationNumber\": \"5680699748\",\n \"phone\": \"803-309-4220\",\n \"specialtyDescription\": \"ADVANCED PRACTICE NURSE\"\n },\n \"selfCertification\": {\n \"type\": \"NON-EXCEPTED INTERSTATE\"\n }\n },\n \"licenseClassHistory\": [\n {\n \"personal\": {\n \"license\": {\n \"classDescription\": \"ALL NON-COMMERCIAL VEH < 26K (EXCEPT MOTORCYCLE)\",\n \"classCode\": \"D\",\n \"issueDate\": \"2016-02-22\",\n \"expirationDate\": \"2026-02-21\",\n \"statusList\": [\n {\n \"name\": \"VALID\",\n \"explanation\": \"NO SUSPENSION\"\n }\n ]\n }\n }\n },\n {\n \"personal\": {\n \"license\": {\n \"classDescription\": \"ALL NON-COMMERCIAL VEH < 26K (EXCEPT MOTORCYCLE)\",\n \"classCode\": \"D\",\n \"issueDate\": \"2016-06-21\",\n \"expirationDate\": \"2026-02-21\",\n \"statusList\": [\n {\n \"name\": \"VALID\",\n \"explanation\": \"NO SUSPENSION\"\n }\n ]\n }\n }\n },\n {\n \"personal\": {\n \"license\": {\n \"classDescription\": \"ALL NON-COMMERCIAL VEH < 26K (EXCEPT MOTORCYCLE)\",\n \"classCode\": \"D\",\n \"issueDate\": \"2017-01-12\",\n \"expirationDate\": \"2026-02-21\",\n \"statusList\": [\n {\n \"name\": \"VALID\",\n \"explanation\": \"NO SUSPENSION\"\n }\n ]\n }\n }\n },\n {\n \"commercial\": {\n \"license\": {\n \"classDescription\": \"LEARNERS - COMB VEH >26K W/TRAILER > 10K\",\n \"classCode\": \"A\",\n \"issueDate\": \"2017-01-13\",\n \"expirationDate\": \"2017-07-12\",\n \"statusList\": [\n {\n \"name\": \"EXPIRED\"\n }\n ],\n \"endorsements\": [\n {\n \"description\": \"TANKS\"\n }\n ]\n }\n }\n },\n {\n \"commercial\": {\n \"license\": {\n \"classDescription\": \"LEARNERS - COMB VEH >26K W/TRAILER > 10K\",\n \"classCode\": \"A\",\n \"issueDate\": \"2017-01-13\",\n \"expirationDate\": \"2017-07-12\",\n \"statusList\": [\n {\n \"name\": \"EXPIRED\"\n }\n ],\n \"endorsements\": [\n {\n \"description\": \"TANKS\"\n }\n ]\n }\n }\n },\n {\n \"personal\": {\n \"license\": {\n \"classDescription\": \"ALL NON-COMMERCIAL VEH < 26K (EXCEPT MOTORCYCLE)\",\n \"classCode\": \"D\",\n \"issueDate\": \"2006-02-21\",\n \"expirationDate\": \"2016-02-21\",\n \"statusList\": [\n {\n \"name\": \"EXPIRED\",\n \"explanation\": \"NO SUSPENSION\"\n }\n ]\n }\n }\n },\n {\n \"personal\": {\n \"license\": {\n \"classDescription\": \"ALL NON-COMMERCIAL VEH < 26K (EXCEPT MOTORCYCLE)\",\n \"classCode\": \"D\",\n \"issueDate\": \"2006-02-21\",\n \"expirationDate\": \"2016-02-21\",\n \"statusList\": [\n {\n \"name\": \"EXPIRED\",\n \"explanation\": \"NO SUSPENSION\"\n }\n ]\n }\n }\n },\n {\n \"personal\": {\n \"license\": {\n \"classDescription\": \"ALL NON-COMMERCIAL VEH < 26K (EXCEPT MOTORCYCLE)\",\n \"classCode\": \"D\",\n \"issueDate\": \"2006-02-21\",\n \"expirationDate\": \"2016-02-21\",\n \"statusList\": [\n {\n \"name\": \"EXPIRED\",\n \"explanation\": \"NO SUSPENSION\"\n }\n ]\n }\n }\n },\n {\n \"personal\": {\n \"license\": {\n \"classDescription\": \"ALL NON-COMMERCIAL VEH < 26K (EXCEPT MOTORCYCLE)\",\n \"classCode\": \"D\",\n \"issueDate\": \"2007-03-20\",\n \"expirationDate\": \"2016-02-21\",\n \"statusList\": [\n {\n \"name\": \"EXPIRED\",\n \"explanation\": \"NO SUSPENSION\"\n }\n ]\n }\n }\n },\n {\n \"personal\": {\n \"license\": {\n \"classDescription\": \"ALL NON-COMMERCIAL VEH < 26K (EXCEPT MOTORCYCLE)\",\n \"classCode\": \"D\",\n \"issueDate\": \"2011-06-14\",\n \"expirationDate\": \"2016-02-21\",\n \"statusList\": [\n {\n \"name\": \"EXPIRED\",\n \"explanation\": \"NO SUSPENSION\"\n }\n ]\n }\n }\n },\n {\n \"personal\": {\n \"license\": {\n \"classDescription\": \"ALL NON-COMMERCIAL VEH < 26K (EXCEPT MOTORCYCLE)\",\n \"classCode\": \"D\",\n \"issueDate\": \"2011-12-05\",\n \"expirationDate\": \"2016-02-21\",\n \"statusList\": [\n {\n \"name\": \"EXPIRED\",\n \"explanation\": \"NO SUSPENSION\"\n }\n ]\n }\n }\n },\n {\n \"personal\": {\n \"license\": {\n \"classDescription\": \"ALL NON-COMMERCIAL VEH < 26K (EXCEPT MOTORCYCLE)\",\n \"classCode\": \"D\",\n \"issueDate\": \"2006-07-21\",\n \"expirationDate\": \"2016-02-21\",\n \"statusList\": [\n {\n \"name\": \"EXPIRED\",\n \"explanation\": \"NO SUSPENSION\"\n }\n ]\n }\n }\n },\n {\n \"personal\": {\n \"license\": {\n \"classDescription\": \"ALL NON-COMMERCIAL VEH < 26K (EXCEPT MOTORCYCLE)\",\n \"classCode\": \"D\",\n \"issueDate\": \"2001-02-21\",\n \"expirationDate\": \"2006-02-21\",\n \"statusList\": [\n {\n \"name\": \"EXPIRED\",\n \"explanation\": \"NO SUSPENSION\"\n }\n ]\n }\n }\n },\n {\n \"personal\": {\n \"license\": {\n \"classDescription\": \"ALL NON-COMMERCIAL VEH < 26K (EXCEPT MOTORCYCLE)\",\n \"classCode\": \"D\",\n \"issueDate\": \"2005-06-06\",\n \"expirationDate\": \"2006-02-21\",\n \"statusList\": [\n {\n \"name\": \"EXPIRED\",\n \"explanation\": \"NO SUSPENSION\"\n }\n ]\n }\n }\n },\n {\n \"motorcycle\": {\n \"license\": {\n \"classDescription\": \"LEARNERS - MOTORCYCLE\",\n \"classCode\": \"M\",\n \"issueDate\": \"2009-07-31\",\n \"expirationDate\": \"2010-07-31\",\n \"statusList\": [\n {\n \"name\": \"EXPIRED\",\n \"explanation\": \"NO SUSPENSION\"\n }\n ]\n }\n }\n },\n {\n \"motorcycle\": {\n \"license\": {\n \"classDescription\": \"LEARNERS - MOTORCYCLE\",\n \"classCode\": \"M\",\n \"issueDate\": \"2009-07-31\",\n \"expirationDate\": \"2010-07-31\",\n \"statusList\": [\n {\n \"name\": \"EXPIRED\",\n \"explanation\": \"NO SUSPENSION\"\n }\n ]\n }\n }\n }\n ],\n \"previousLicenses\": [\n {\n \"license\": {\n \"licenseNumber\": \"7777777\",\n \"licenseState\": \"SC\"\n },\n \"classCode\": \"A\"\n },\n {\n \"license\": {\n \"licenseNumber\": \"7777777\",\n \"licenseState\": \"SC\"\n },\n \"classCode\": \"D\"\n }\n ]\n}"},{"id":"f590acc2-f909-4fda-af9e-f87120c3713c","name":"200 OK: Baseline Version=2.0.4","originalRequest":{"method":"GET","header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Record\": {\n \"DlRecord\": {\n \"Criteria\": {\n \"OrderDate\": {\n \"Year\": 2024,\n \"Month\": 2,\n \"Day\": 26,\n \"Full\": \"2024-02-26\",\n \"Ticks\": 1708905600000\n },\n \"OrderTime\": {\n \"Hour\": \"13\",\n \"Minute\": \"28\",\n \"Second\": \"0\"\n },\n \"AccountID\": \"K1619\",\n \"UserID\": \"K161937\",\n \"Routing\": \"LILO\",\n \"Purpose\": \"AA\",\n \"TrackingNumber\": \"000000\",\n \"Host\": \"OL\",\n \"ProductID\": \"DX\",\n \"State\": {\n \"Abbrev\": \"OH\",\n \"Full\": \"OHIO\"\n },\n \"Subtype\": \"ST\",\n \"SubtypeFull\": \"DATABASE LOOKBACK\",\n \"FirstName\": \"JOHN\",\n \"MiddleName\": \"R\",\n \"LastName\": \"DOE\",\n \"BirthDate\": {\n \"Year\": 1980,\n \"Month\": 8,\n \"Day\": 16,\n \"Full\": \"1980-08-16\",\n \"Ticks\": 335232000000\n },\n \"LicenseNumber\": \"SS201801\",\n \"OrderLookBackStartDate\": {\n \"Year\": 2015,\n \"Month\": 7,\n \"Day\": 16,\n \"Full\": \"2015-07-16\",\n \"Ticks\": 1437004800000\n },\n \"Source\": \"13\"\n },\n \"Result\": {\n \"Control\": \"08230J\",\n \"Valid\": \"Y\",\n \"ReturnedDate\": {\n \"Year\": 2024,\n \"Month\": 2,\n \"Day\": 26,\n \"Full\": \"2024-02-26\",\n \"Ticks\": 1708905600000\n },\n \"ReturnedTime\": {\n \"Hour\": \"13\",\n \"Minute\": \"28\",\n \"Second\": \"0\"\n },\n \"CompanyClass\": \"CLEAR\",\n \"CompanyScore\": \"0\",\n \"CompanyScoreInt\": 0,\n \"CompanyVersion\": \"1-08\",\n \"IsClear\": \"Y\",\n \"InvoicePath\": \"BASELINE\",\n \"ResultCode\": \"RB\"\n },\n \"Driver\": {\n \"FirstName\": \"JOHN\",\n \"MiddleName\": \"R\",\n \"LastName\": \"DOE\",\n \"Deceased\": \"N\"\n },\n \"CurrentLicense\": {\n \"Commercial\": {\n \"Type\": \"COMMERCIAL\",\n \"ClassDescription\": \"COMBINE VEH > 26K W/TRAILER > 10K\",\n \"ClassCode\": \"A\",\n \"IssueDate\": {\n \"Year\": 2017,\n \"Month\": 7,\n \"Day\": 25,\n \"Full\": \"2017-07-25\",\n \"Ticks\": 1500940800000\n },\n \"ExpirationDate\": {\n \"Year\": 2021,\n \"Month\": 10,\n \"Day\": 22,\n \"Full\": \"2021-10-22\",\n \"Ticks\": 1634860800000\n },\n \"StatusList\": [\n {\n \"Name\": \"VALID\"\n }\n ],\n \"EndorsementList\": [\n {\n \"Name\": \"MOTORCYCLE\"\n },\n {\n \"Name\": \"TANK VEHICLE - CDL\"\n },\n {\n \"Name\": \"PASSENGER - CDL\"\n },\n {\n \"Name\": \"DOUBLE-/TRIPLE-TRAILERS - CDL\"\n }\n ],\n \"RestrictionList\": [\n {\n \"Name\": \"NO CLASS A PASSENGER VEHICLE\"\n }\n ]\n },\n \"Number\": \"SS201801\",\n \"HasDriverTraining\": \"3\"\n },\n \"MedicalCertificateList\": [\n {\n \"ExpirationDate\": {\n \"Year\": 2021,\n \"Month\": 2,\n \"Day\": 8,\n \"Full\": \"2021-02-08\",\n \"Ticks\": 1612742400000\n },\n \"SelfCertification\": {\n \"Type\": \"NON-EXCEPTED INTERSTATE\",\n \"TypeCode\": \"NI\"\n }\n }\n ],\n \"MessageList\": [\n [\n {\n \"Line\": \"SCORE 0: CLEAN\"\n }\n ]\n ]\n }\n }\n}"},{"id":"d7424158-5411-413d-b114-a25efd15fb05","name":"200 OK: Baseline Version=2.0.3 XML","originalRequest":{"method":"GET","header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"The Intelligent MVR service utilizes SambaSafety’s proprietary datasets using the personal identifiers submitted
to locate records that can verify license activity and/or violations.
Provides an initial Baseline MVR with first order.
\nAll orders placed after the baseline MVR for the person will perform an activity check, ordering a state MVR only when new activity is present.
\nIf no activity, report returned indicating driver activity check is clear.
\nAuthentication: Obtain a token to gain access
\nPlace an Order: Place an order to get data for the person
\nCheck Order Status: Check whether an order that has been placed has been fulfilled
\nGet a Report: Get the data ordered
\nFor more information on Intelligent MVR visit our SambaSafety Knowledge Base
\n","_postman_id":"6b174545-5952-43b3-92df-d68e982574db","auth":{"type":"apikey","apikey":{"key":"(Required) The unique identifier of the platform organization
\n"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/orders/v1/activityreports/detail?page=1&size=50&startOrderDate=2023-01-01&endOrderDate=2023-09-15","description":"This endpoint retrieves list of previouss orders placed for the Service. The request does not include a request body. Upon successful request, the API will respond with a list of previously placed orders, including the current order status.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: application/json
X-Api-Key: [ApiKey]
Parameters:
\npage:the page of transactions to review. Default value: 1
size:the number of transactions to review on a page. Default value:25
startOrderDate: Start date when orders were created. If value is not provided, search will default to midnight (00:00:00 a.m.) of previous day.
endOrderDate Inclusive end date when orders were created. If value is not provided, search will default to end of day (23:59:59 p.m.).
Parameters:
\ndata
errorMessage (string): An error message attached to the order.
orderId (string, uuid): The license's unique identifier.
status (string): The enrollment type.
request (object): The order request object from Place an Order.
createdDateTime (string, datetime): The timestamp of the order.
meta
totalPages (number): The total number of pages.
totalRecords (number): The total number of records.
links
self (string, url): The URL to the current page.
first (string, url): The URL to the first page of data.
next (string, url): The URL to the next page of data.
prev (string, url): The URL to the previous page of data.
last (string, url): The URL to the last page of data.
The page of data being displayed.
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"The number of items on a page.
\n","type":"text/plain"},"key":"size","value":"50"},{"description":{"content":"Start date when orders were created. If value is not provided, search will default to midnight (00:00:00 a.m.) of previous day.
\nPattern: yyyy-MM-dd
\n","type":"text/plain"},"key":"startOrderDate","value":"2023-01-01"},{"description":{"content":"Inclusive end date when orders were created. If value is not provided, search will default to end of day (23:59:59 p.m.).
\nPattern: yyyy-MM-dd
\n","type":"text/plain"},"key":"endOrderDate","value":"2023-09-15"}],"variable":[]}},"response":[{"id":"4c690941-ff32-4577-899b-ec489bb39330","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}","description":"(Required) The unique identifier of the platform organization"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer(Required) The unique identifier of the platform organization
\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"birthDate\": \"1980-08-16\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"licenseNumber\": \"1234567890\",\n \"licenseState\": \"CA\",\n \"middleName\": \"Alexander\",\n \"suffix\": \"\",\n \"billCode\": \"\",\n \"billReference\": \"\",\n \"purpose\": \"INSURANCE\",\n \"options\": [\n \"LICENSE_VALIDATION\"\n ],\n \"customFields\": [\n {\n \"name\": \"Custom Field\",\n \"value\": \"Custom Value\"\n }\n ],\n \"licenseCategory\": \"LICENSE\",\n \"issueDate\": \"1998-08-16\",\n \"expiryDate\": \"2008-08-16\",\n \"eyeColor\": \"BLACK\",\n \"gender\": \"MALE\",\n \"address\": {\n \"street\": \"495 Grove Street\",\n \"city\": \"Boulder\",\n \"state\": \"CO\",\n \"zipCode\": \"80301\"\n },\n \"height\": 510,\n \"weight\": 195,\n \"activityDuration\": 24\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/orders/v1/activityreports/detailquote","description":"This endpoint creates a new order for an Activity Detail Report, using the SambaSafety Quote feature.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: application/json
X-Api-Key: [ApiKey]
Parameters:
\npurpose (string, required): The purpose of the order. [\"EMPLOYMENT\", \"INSURANCE\"]
licenseCategory (string, required): The document's category, License Category.
licenseState (string, required): The state jurisdiction issuing the document, US State Abbreviation.
licenseNumber (string, required): The person's family name, as indicated on the document.
birthDate (string, date, required): The person's date of birth.
lastName (string, required): The person's family name, as indicated on the document.
firstName (string, required): The person's given name, as indicated on the document.
middleName (string, optional): The person's middle name or initial, if indicated on the document.
suffix (string, optional): The person's family suffix, Suffix.
address (object, optional): An address object containing:
street (string): The person's mailing street address.
city (string): The person's mailing municipality.
state (string): The person's mailing state, US State Abbreviation.
zipCode (string): The person's mailing postal code.
gender (string, optional): The person's gender, Gender.
height (number, optional): The person's height.
weight (number, optional): The person's weight.
eyeColor (string, optional): The person's eye-color, Eye-Color.
issueDate (string, date, optional): The document's issue date.
expiryDate (string, date, optional): The document's expiration date.
options (Array[string], optional): A list of bundled options. i.e. \"LICENSE_VALIDATION\"
customFields (Array[object], optional): A customer's custom fields.
billCode (string, optional): A customer's custom billing code.
billReference (string, optional): A customer's custom billing reference note.
activityDuration (number, optional): The number of months of activity.
Upon successful request, the API will respond with the a 201 Created containing the order ID.
\nParameters:
\norderId (string, uuid): The order's unique identifier.(Required) The unique identifier of the platform organization
\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"birthDate\": \"1980-08-16\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"licenseNumber\": \"1234567890\",\n \"licenseState\": \"CA\",\n \"middleName\": \"Alexander\",\n \"suffix\": \"\",\n \"billCode\": \"\",\n \"billReference\": \"\",\n \"purpose\": \"INSURANCE\",\n \"options\": [\n \"LICENSE_VALIDATION\"\n ],\n \"customFields\": [\n {\n \"name\": \"Custom Field\",\n \"value\": \"Custom Value\"\n }\n ],\n \"licenseCategory\": \"LICENSE\",\n \"issueDate\": \"1998-08-16\",\n \"expiryDate\": \"2008-08-16\",\n \"eyeColor\": \"BLACK\",\n \"gender\": \"MALE\",\n \"address\": {\n \"street\": \"495 Grove Street\",\n \"city\": \"Boulder\",\n \"state\": \"CO\",\n \"zipCode\": \"80301\"\n },\n \"height\": 510,\n \"weight\": 195,\n \"vaultAge\": 30\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/orders/v1/activityreports/detail","description":"This endpoint creates a new order for an Activity Detail Report, for a single driver.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: application/json
X-Api-Key: [ApiKey]
Parameters:
\npurpose (string, required): The purpose of the order. [\"EMPLOYMENT\", \"INSURANCE\"]
licenseCategory (string, required): The document's category, License Category.
licenseState (string, required): The state jurisdiction issuing the document, US State Abbreviation.
licenseNumber (string, required): The person's family name, as indicated on the document.
birthDate (string, date, required): The person's date of birth.
lastName (string, required): The person's family name, as indicated on the document.
firstName (string, required): The person's given name, as indicated on the document.
middleName (string, optional): The person's middle name or initial, if indicated on the document.
suffix (string, optional): The person's family suffix, Suffix.
address (object, optional): An address object containing:
street (string): The person's mailing street address.
city (string): The person's mailing municipality.
state (string): The person's mailing state, US State Abbreviation.
zipCode (string): The person's mailing postal code.
gender (string, optional): The person's gender, Gender.
height (number, optional): The person's height.
weight (number, optional): The person's weight.
eyeColor (string, optional): The person's eye-color, Eye-Color.
issueDate (string, date, optional): The document's issue date.
expiryDate (string, date, optional): The document's expiration date.
options (Array[string], optional): A list of bundled options. i.e. \"LICENSE_VALIDATION\"
customFields (Array[object], optional): A customer's custom fields.
billCode (string, optional): A customer's custom billing code.
billReference (string, optional): A customer's custom billing reference note.
vaultAge (number, optional): Integer value for vault age in days.
Values accepted:
0 = no vault allowed
\n1-1095 = days
\nUpon successful request, the API will respond with the a 201 Created containing the order ID.
\nParameters:
\norderId (string, uuid): The order's unique identifier.(Required) The unique identifier of the platform organization
\n"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/orders/v1/activityreports/detail/:orderId","description":"This endpoint retrieves summary information for the corresponding order ID. The request does not include a request body.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: application/json
X-Api-Key: [ApiKey]
Parameters:
\norderId the unique identifer for the order.Upon successful request, the API will respond with details for the corresponding order. Contains the orderStatus and a links reference to the report, when completed.
\nParameters:
\norderId (string, uuid): The order's unique identifier.
orderStatus (string): The status of the order.
orderDateTime (string, datetime): The timestamp of the order.
orderCompletedDateTime (string, datetime): The timestamp of the order was completed.
controlNumber (string): A SambaSafety identifier for the order.
links (object): An array of links related to the order.
rel (string): The relationship of the link.
href (string): The URL of the link.
type (string): The HTTP Method used to access the link.
id (string): The unique identifier associated with the link.
If you have subscribed to the webhook when the order has been successfully \"fulfilled\", the CallbackURL will be invoked with a \"POST\" and a body containing a url link to the report, and the report uuid.
\nIf an error occurs, the response will have an “error\" event type, with a description of the error.
\nactivitydetail.received
activitydetail.error
Parameters:
\neventId (string, uuid): The callback event's unique identifier.
data (object): The order summary object containing:
orderId (string, uuid): The order's unique identifier.
links (array): An array of links related to the order.
rel (string): The relationship of the link.
href (string): The URL of the link.
type (string): The HTTP Method used to access the link.
id (string): The unique identifier associated with the link.
orderDate (string, datetime): The timestamp of the order.
productOrdered (string): The product ordered (subType).
createdDateTime (string, date): The callback event's timestamp.-
eventType (string): The callback event name.
(Required) The order's unique identifier.
\n","type":"text/plain"},"type":"any","value":"","key":"orderId"}]}},"response":[{"id":"efb95808-3721-4a8f-b96f-2ae4483f81e1","name":"200 OK: Status: Fulfilled","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}","description":"(Required) The unique identifier of the platform organization"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer(Required) The unique identifier of the platform organization
\n"},{"key":"Accept","value":"application/vnd.sambasafety.json;version=2.0.4"}],"url":"{{baseUrl}}/reports/v1/activityreports/detail/:reportId","description":"This endpoint retrieves Activity Detail Report for the corresponding Report ID.
\nContent-Type: application/json
Authorization: Bearer [Token]
Accept: [Document Version]
X-Api-Key: [ApiKey]
Available Versions:
\napplication/vnd.sambasafety.json;version=2.0.4
\napplication/vnd.sambasafety.xml;version=2.0.3
\napplication/vnd.sambasafety.xml;version=2.0.2
\napplication/vnd.sambasafety.xml;version=2.0.0
\napplication/vnd.sambasafety.html
\napplication/vnd.sambasafety.pdf ( Base64 Encoded String )
\nParameters:
\nreportId: the unique identifer for the Activity Detail Report.Upon successful request, the API will respond with the Activity Detail Report for the reportId and report version requested.
Parameters:
\nRecord
JrRecord
Criteria (object) Contains parameters sent with the request.