{"openapi":"3.0.1","info":{"title":"24-seven-fees-ramquest-experience-api","description":"24 Seven Fees RamQuest Experience API","version":"1.0.0"},"servers":[{"url":"https://dev-api.24sevenfees.com/ramquest-experience-api/api"},{"url":"https://test-api.24sevenfees.com/ramquest-experience-api/api"}],"paths":{"/recordingFees":{"post":{"tags":["Recording"],"description":"Gather a list of Recording Fees","parameters":[{"$ref":"#/components/parameters/apiKey"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/recordingRequest"}}}},"responses":{"201":{"description":"Successful quote creation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recordingResponse"}}}},"400":{"$ref":"#/components/responses/generic400"},"401":{"$ref":"#/components/responses/generic401"},"403":{"$ref":"#/components/responses/generic403"},"500":{"$ref":"#/components/responses/generic500"}}}},"/underwriterRates":{"post":{"tags":["Underwriters"],"description":"Gather a list of Underwriter Rates","parameters":[{"$ref":"#/components/parameters/apiKey"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/underwritersRequest"}}}},"responses":{"201":{"description":"Successful quote creation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/underwritersResponse"}}}},"400":{"$ref":"#/components/responses/generic400"},"401":{"$ref":"#/components/responses/generic401"},"403":{"$ref":"#/components/responses/generic403"},"500":{"$ref":"#/components/responses/generic500"}}}}},"components":{"schemas":{"errorType":{"required":["error","errorId","errorType"],"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"level":{"type":"string","example":"ERROR"},"type":{"type":"string","example":"Error Type Here"},"details":{"type":"string","example":"HTTP request failed"},"diagnostics":{"type":"string","example":"Error Info Here"}}}},"trail":{"type":"string","example":"API Path Here"}}},"currency":{"description":"A US dollar amount in minimum 1 cent increments","type":"number","multipleOf":0.01},"localDate":{"description":"Local Date in ISO 8601 format YYYY-MM-DD","type":"string","pattern":"^(\\d{4})-([0]?[1-9]|[1][0-2])-([0]?[1-9]|[1-2]\\d|[3][0-1])$","example":"2023-08-31"},"state":{"description":"2 letter US state abbreviation","type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","DC","MH","GU","AS","CM","PW","PR","TT","VI"]},"uuid":{"description":"A Universal Unique ID used as a specific record reference","type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"zipCode":{"description":"A 5 digit US Postal Zip code.  Represented by a string to include prepended zeros.","type":"string","pattern":"^\\d{5}$","example":"90210"},"metadata":{"description":"A Generic key/value type metadata represented as an object. May contain any kind of data.","type":"object"},"address":{"description":"A U.S. style physical address","type":"object","additionalProperties":false,"required":["city","state","zip","county"],"properties":{"line1":{"type":"string"},"line2":{"type":"string","nullable":true},"city":{"type":"string"},"state":{"$ref":"#/components/schemas/state"},"zip":{"$ref":"#/components/schemas/zipCode"},"county":{"type":"string"}}},"split":{"description":"A buyer/seller split","type":"object","required":["buyer","seller"],"properties":{"buyer":{"$ref":"#/components/schemas/currency"},"seller":{"$ref":"#/components/schemas/currency"},"other":{"$ref":"#/components/schemas/currency"}}},"transactionType":{"description":"The transaction type of the call","example":"PURCHASE W/ LOAN","type":"string","enum":["PURCHASE W/ LOAN","CASH","REFINANCE","REVERSE MORTGAGE"]},"notes":{"description":"A list of notes that reveal details about the resource it's contained within","type":"array","items":{"type":"string"}},"property":{"type":"object","additionalProperties":false,"required":["address"],"properties":{"address":{"$ref":"#/components/schemas/address"},"metadata":{"allOf":[{"$ref":"#/components/schemas/metadata"},{"description":"Additional metadata associated with the property.  Such as a New Mexico location code. Typically an empty object"}]}},"example":{"address":{"line1":"123 W Chicago Ave","line2":"","city":"Chicago","state":"IL","zip":"60654","county":"Cook"}}},"feeType":{"type":"string","example":"Recording","enum":["Underwriter","Settlement","Lender","Recording","Commission","Proration","Other"]},"fee":{"description":"A rate or fee item","type":"object","additionalProperties":false,"required":["name","type","split","amount","messages"],"properties":{"name":{"description":"The name of the rate/fee","example":"Transfer Tax Amount - City (Deed)","type":"string"},"type":{"$ref":"#/components/schemas/feeType"},"typeDetail":{"description":"Additional identifying information about the type of rate","example":"Deed","type":"string"},"split":{"$ref":"#/components/schemas/split"},"amount":{"$ref":"#/components/schemas/currency"},"messages":{"$ref":"#/components/schemas/notes"},"rateEffectiveDate":{"$ref":"#/components/schemas/localDate"}}},"lineItemList":{"type":"array","items":{"$ref":"#/components/schemas/fee"},"example":{"$ref":"#/components/examples/lineItemsRecordingExample"}},"recordingRequest":{"title":"Recording Request","type":"object","additionalProperties":false,"required":["transactionType","property","salesAmount","loanAmount"],"properties":{"transactionType":{"$ref":"#/components/schemas/transactionType"},"property":{"$ref":"#/components/schemas/property"},"salesAmount":{"allOf":[{"$ref":"#/components/schemas/currency"},{"example":500000}]},"loanAmount":{"allOf":[{"$ref":"#/components/schemas/currency"},{"example":400000}]}}},"recordingResponse":{"title":"Recording Response","type":"object","additionalProperties":false,"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/feeType"},{"example":"Recording"}]},"vendor":{"type":"string","description":"Name of the source vendor which is providing the listed rates and fees","example":"24 Seven Fees RFTT"},"vendorUuid":{"allOf":[{"$ref":"#/components/schemas/uuid"},{"description":"UUID of vendor source for debugging and verification"},{"example":"70658770-8325-11e9-a136-0242ac130002"}]},"lineItems":{"$ref":"#/components/schemas/lineItemList"},"notes":{"$ref":"#/components/schemas/notes"},"sourceMetadata":{"allOf":[{"$ref":"#/components/schemas/metadata"},{"description":"Additional response data provided from the source vendor"}]}}},"underwritersRequest":{"title":"Underwriter Request","type":"object","additionalProperties":false,"required":["transactionType","property","salesAmount","loanAmount","estimatedClosingDate"],"properties":{"transactionType":{"$ref":"#/components/schemas/transactionType"},"property":{"$ref":"#/components/schemas/property"},"salesAmount":{"$ref":"#/components/schemas/currency"},"loanAmount":{"$ref":"#/components/schemas/currency"},"reissue":{"description":"Indicates if this transaction is a reissue","type":"boolean"},"endorsements":{"description":"A list of endorsements by name","type":"array","items":{"type":"string"},"example":["COMPREHENSIVE ENDORSEMENT","EPA ENDORSEMENT"]},"estimatedClosingDate":{"$ref":"#/components/schemas/localDate"}}},"underwritersResponse":{"title":"Underwriter Response","type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/feeType"},{"example":"Underwriter"}]},"vendor":{"type":"string","description":"Name of the source vendor which is providing the listed rates and fees","example":"Old Republic National Title Insurance Company"},"vendorUuid":{"allOf":[{"$ref":"#/components/schemas/uuid"},{"description":"UUID of vendor source for debugging and verification"},{"example":"ab84df30-e31d-11ea-a71f-9fb07abc474d"}]},"lineItems":{"allOf":[{"$ref":"#/components/schemas/lineItemList"},{"example":{"$ref":"#/components/examples/lineItemsUnderwritersExample"}}]},"notes":{"$ref":"#/components/schemas/notes"},"sourceMetadata":{"$ref":"#/components/schemas/metadata"}}}},"parameters":{"apiKey":{"name":"apiKey","in":"header","required":true,"schema":{"$ref":"#/components/schemas/uuid"}}},"responses":{"generic200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"generic201":{"description":"Updated","content":{"application/json":{"schema":{"type":"object"}}}},"generic400":{"description":"Bad Request Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorType"}}}},"generic401":{"description":"Unauthorized Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorType"}}}},"generic403":{"description":"Forbidden Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorType"}}}},"generic404":{"description":"Not Found Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorType"}}}},"generic500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorType"}}}}},"examples":{"lineItemsRecordingExample":{"value":[{"name":"Transfer Tax Amount -  State (Deed)","type":"Recording","typeDetail":"Deed","split":{"buyer":0,"seller":123,"other":0},"amount":123,"messages":[]},{"name":"Transfer Tax Amount - County (Deed)","type":"Recording","typeDetail":"Deed","split":{"buyer":0,"seller":61.5,"other":0},"amount":61.5,"messages":[]},{"name":"Transfer Tax Amount - City (Deed)","type":"Recording","typeDetail":"Deed","split":{"buyer":0,"seller":1291.5,"other":0},"amount":1291.5,"messages":[]}]},"lineItemsUnderwritersExample":{"value":[{"name":"Old Republic National Title Insurance Company Owners Policy (Basic)","type":"Underwriter","typeDetail":"OWNERS POLICY","split":{"buyer":2345,"seller":0,"other":0},"amount":2345,"messages":[],"rateEffectiveDate":"2021-02-01"},{"name":"Old Republic National Title Insurance Company Simultaneous Issue (Basic)","type":"Underwriter","typeDetail":"SIMULTANEOUS ISSUE","split":{"buyer":550,"seller":0,"other":0},"amount":550,"messages":["Simultaneous rates applied"],"rateEffectiveDate":"2021-02-01"},{"name":"COMPREHENSIVE ENDORSEMENT","type":"Underwriter","typeDetail":"ENDORSEMENT","split":{"buyer":180,"seller":0,"other":0},"amount":180,"messages":[],"rateEffectiveDate":"2022-02-22"}]}}}}