{ "swagger": "2.0", "info": { "version": "1.0.0", "title": "AddressStandardization", "description": "Standardize submitted address and identify various address attributes as provided by the USPS" }, "host": "apitest.microbilt.com", "basePath": "/AddressStandardization", "schemes": [ "https" ], "paths": { "/": { "post": { "description": "Get report associated with address", "summary": "Gets Address Standardization", "operationId": "GetReport", "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, "description": "Gets Address Standardization", "schema": { "$ref": "#/definitions/AddressStandardizationRq" }, "x-example": { "application/json": [ { "name": "JSON request example", "body": "{\"Address\":{\"Addr1\":\"1640 Airport Road #115\",\"City\":\"Kennesaw\",\"State\":\"GA\",\"Zip\":\"30144\"}}" } ], "application/xml": [ { "name": "XML request example", "body": "

1640 Airport Road #115KennesawGeorgia30144

" } ] } } ], "responses": { "200": { "description": "GetReport", "schema": { "$ref": "#/definitions/AddressStandardizationRs" }, "examples": {} } }, "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": { "AddressStandardizationRq": { "type": "object", "properties": { "Address": { "$ref": "#/definitions/Address" } } }, "Address": { "type": "object", "properties": { "Addr1": { "type": "string" }, "Addr2": { "type": "string" }, "StreetName": { "type": "string" }, "StreetNum": { "type": "string" }, "Apt": { "type": "string" }, "City": { "type": "string" }, "State": { "type": "string" }, "Zip": { "type": "string" }, "County": { "type": "string" }, "Country": { "type": "string" } } }, "AddressStandardizationRs": { "type": "object", "properties": { "MsgRsHdr": { "$ref": "#/definitions/MsgRsHdr" }, "Address": { "$ref": "#/definitions/Address" }, "AddressType": { "type": "string" }, "AddressValidation": { "$ref": "#/definitions/FlagVCode" }, "ResidentialAddressVerification": { "$ref": "#/definitions/FlagVCode" } } }, "FlagVCode": { "type": "object", "properties": { "VerificationFlag": { "type": "string" }, "VCode": { "type": "integer", "format": "int32" }, "VCodeDescription": { "type": "string" } } }, "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" } } } } }