{ "swagger": "2.0", "info": { "version": "1.0.0", "title": "PhoneNameVerification", "description": "Delivers match indicator to confirm the Phone and Name submitted on an application" }, "host": "apitest.microbilt.com", "basePath": "/PhoneNameVerification", "schemes": [ "https" ], "paths": { "/": { "post": { "description": "Get report associated with phone and name", "summary": "Get the PhoneNameVerification", "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 PhoneNameVerification", "schema": { "$ref": "#/definitions/PhoneNameVerificationRq" }, "x-example": { "application/json": [ { "name": "Test PhoneNameVerification", "body": "{\"Name\":{\"FirstName\":\"John\",\"MiddleName\":\"Percival\",\"LastName\":\"Smith\"},\"PhoneNumber\":\"1-800-884-4747\"}" } ], "application/xml": [ { "name": "Test PhoneNameVerification", "body": "JohnPercivalSmith1-800-884-4747" } ] } } ], "responses": { "200": { "description": "GetReport", "schema": { "$ref": "#/definitions/PhoneNameVerificationRs" }, "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": { "PhoneNameVerificationRq": { "type": "object", "properties": { "Name": { "$ref": "#/definitions/Name" }, "Address": { "$ref": "#/definitions/Address" }, "TaxId": { "description": "Tax identification number", "type": "string", "example": "123-10-4321" }, "PhoneNumber": { "description": "Phone number", "type": "string", "example": "1-800-884-4747" } } }, "Name": { "type": "object", "properties": { "FirstName": { "type": "string" }, "MiddleName": { "type": "string" }, "LastName": { "type": "string" } } }, "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" } } }, "PersonNameEmail": { "type": "object", "properties": { "FirstName": { "type": "string", "example": "John", "description": "First name" }, "MiddleName": { "type": "string", "example": "Percival", "description": "Middle name" }, "LastName": { "type": "string", "example": "Smith", "description": "Last name" } } }, "ContactInfoEmail": { "type": "object", "properties": { "PhoneNum": { "$ref": "#/definitions/PhoneNumEmail" }, "PostAddr": { "$ref": "#/definitions/PostAddrEmail" } } }, "PhoneNumEmail": { "type": "object", "properties": { "Phone": { "type": "string", "example": "1-800-884-4747", "description": "Phone number" } } }, "PostAddrEmail": { "type": "object", "properties": { "Addr1": { "type": "string", "example": "1641 Airport Rd. Suite 115 Kennesaw, GA 30144, US", "description": "First address" }, "Addr2": { "type": "string", "example": "", "description": "Second address" }, "Apt": { "type": "string", "example": "115", "description": "Apartment number/office number" }, "StreetName": { "type": "string", "example": "Airport", "description": "Street name" }, "StreetNum": { "type": "string", "example": "1640", "description": "Street number" }, "StreetType": { "type": "string", "example": "Rd.", "description": "Street type" }, "City": { "type": "string", "example": "Kennesaw", "description": "City" }, "StateProv": { "type": "string", "example": "GA", "description": "State or Province" }, "PostalCode": { "type": "string", "example": "30144", "description": "Postal code" }, "Country": { "type": "string", "example": "US", "description": "Country" } } }, "TINInfoEmail": { "type": "object", "properties": { "TINType": { "type": "string", "example": "1", "description": "Tax identification document type" }, "TaxId": { "type": "string", "example": "123-45-6789", "description": "Tax identification number" } } }, "PhoneNameVerificationRs": { "type": "object", "properties": { "MsgRsHdr": { "$ref": "#/definitions/MsgRsHdrEmail" }, "VerificationFlags": { "$ref": "#/definitions/FlagVCodeResponse" } } }, "MsgRsHdrEmail": { "type": "object", "properties": { "RqUID": { "type": "string" }, "Status": { "$ref": "#/definitions/StatusEmail" } } }, "StatusEmail": { "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/AdditionalStatusEmail" } } } }, "AdditionalStatusEmail": { "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" } } }, "FlagVCodeResponse": { "type": "object", "properties": { "VerificationFlag": { "type": "string" }, "VCode": { "type": "integer", "format": "int32" } } } } }