{ "swagger": "2.0", "info": { "version": "1.0.0", "title": "DLVerify", "description": "Validation attributes confirming submitted DL matches correct format for the submitted State" }, "host": "apitest.microbilt.com", "basePath": "/DLVerify", "schemes": [ "https" ], "paths": { "/GetReport": { "post": { "description": "Verify Driver License", "summary": "Verify Driver License", "operationId": "GetReport", "produces": [ "application/json", "application/xml" ], "parameters": [ { "name": "Content-Type", "description": "Specifies the format of the request", "in": "header", "required": true, "type": "string", "enum": [ "application/json", "application/xml" ] }, { "name": "Accept", "description": "Specifies the format of the response", "in": "header", "required": true, "type": "string", "enum": [ "application/json", "application/xml" ] }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/MBDLVerifyRq" }, "x-example": { "application/json": [ { "name": "Valid DL", "body": "{\"PersonInfo\": {\"PersonName\": {\"FirstName\": \"John\",\"LastName\": \"Smith\"},\"DriversLicense\": {\"LicenseNum\": \"1299011\",\"StateProv\": \"AK\"}}}" }, { "name": "Invalid DL", "body": "{\"PersonInfo\":{\"PersonName\":{\"FirstName\":\"John\",\"LastName\":\"Smith\"},\"DriversLicense\":{\"LicenseNum\":\"122901241\",\"StateProv\":\"AK\"}}}" } ], "application/xml": [ { "name": "XML request example", "body": "JohnSmith1299011AK" } ] } } ], "responses": { "default": { "description": "GetReport", "schema": { "$ref": "#/definitions/MBDLVerifyRs" } } }, "security": [ { "oauth": [ ] } ] } }, "/GetArchiveReport": { "get": { "description": "Gets Archived DL Report", "summary": "Gets Archived DL Report", "operationId": "GetArchiveReport", "produces": [ "application/json", "application/xml" ], "parameters": [ { "name": "Accept", "description": "Specifies the format of the response", "in": "header", "required": true, "type": "string", "enum": [ "application/json", "application/xml" ] }, { "name": "AppId", "required": true, "in": "query", "type": "string", "default": "" } ], "responses": { "default": { "description": "GetArchiveReport", "schema": { "$ref": "#/definitions/MBDLVerifyRs" } } }, "security": [ { "oauth": [ ] } ] } } }, "securityDefinitions": { "oauth": { "type": "oauth2", "authorizationUrl": "https://apitest.microbilt.com/OAuth/GetAccessToken?grant_type=client_credentials", "tokenUrl": "https://apitest.microbilt.com/OAuth/GetAccessToken?grant_type=client_credentials", "flow": "accessCode", "scopes": {} } }, "definitions": { "MBDLVerifyRq": { "type": "object", "properties": { "PersonInfo": { "$ref": "#/definitions/PersonInfo" } } }, "PersonInfo": { "type": "object", "properties": { "PersonName": { "$ref": "#/definitions/PersonName" }, "TINInfo": { "$ref": "#/definitions/TINInfo" }, "BirthDt": { "type": "string", "format": "date-time" }, "DriversLicense": { "$ref": "#/definitions/DriversLicense" }, "ValidationInfo": { "$ref": "#/definitions/ValidationInfo" } } }, "PersonName": { "type": "object", "properties": { "FirstName": { "type": "string", "example": "John" }, "LastName": { "type": "string", "example": "Smith" }, "MiddleName": { "type": "string" } } }, "Message": { "type": "object", "properties": { "MsgClass": { "type": "string" }, "MsgCode": { "type": "string" }, "Text": { "type": "string" }, "Source": { "type": "string" }, "EffDt": { "type": "string", "format": "date-time" } } }, "ValidationInfo": { "type": "object", "properties": { "DLValidation": { "type": "array", "items": { "$ref": "#/definitions/Message" } } } }, "TINInfo": { "type": "object", "properties": { "TINType": { "type": "string" }, "TaxId": { "type": "string" } } }, "DriversLicense": { "type": "object", "properties": { "LicenseNum": { "type": "string", "example": "1299011" }, "StateProv": { "type": "string", "example": "AK" }, "IssuedDt": { "type": "string", "format": "date-time" }, "ExpirationDt": { "type": "string", "format": "date-time" } } }, "CodeDescription": { "type": "object", "properties": { "Code": { "type": "string" }, "Description": { "type": "string" } } }, "MBDLVerifyRs": { "type": "object", "properties": { "MsgRsHdr": { "$ref": "#/definitions/MsgRsHdr" }, "RefNum": { "type": "string" }, "Subject": { "type": "array", "items": { "$ref": "#/definitions/MBDLVerifyRsSubject" } } } }, "MsgRsHdr": { "type": "object", "properties": { "RqUID": { "type": "string" }, "Status": { "$ref": "#/definitions/Status" } } }, "Status": { "type": "object", "properties": { "StatusCode": { "type": "integer", "format": "int64" }, "ServerStatusCode": { "type": "string" }, "Severity": { "type": "string", "enum": [ 0, 1, 2 ], "x-enumNames": [ "Error", "Warn", "Info" ] }, "StatusDesc": { "type": "string" }, "AdditionalStatus": { "type": "array", "items": { "$ref": "#/definitions/AdditionalStatus" } } } }, "AdditionalStatus": { "type": "object", "properties": { "StatusCode": { "type": "integer", "format": "int64" }, "ServerStatusCode": { "type": "string" }, "Severity": { "type": "string", "enum": [ 0, 1, 2 ], "x-enumNames": [ "Error", "Warn", "Info" ] }, "StatusDesc": { "type": "string" } } }, "MBDLVerifyRsSubject": { "type": "object", "properties": { "PersonInfo": { "$ref": "#/definitions/PersonInfo" }, "DLValidation": { "$ref": "#/definitions/Message" }, "Message": { "type": "array", "items": { "$ref": "#/definitions/Message" } } } } } }