{ "components": { "schemas": {}, "securitySchemes": { "bearerAuth": { "bearerFormat": "JWT", "description": "JWT Token", "scheme": "bearer", "type": "http" } } }, "info": { "description": "Development documentation", "title": "Lenders API", "version": "1.4.0" }, "openapi": "3.1.0", "paths": { "/v1/auth/token": { "post": { "description": "Get an access token", "operationId": "postV1AuthToken", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "properties": { "client_id": { "description": "The client ID", "type": "string" }, "client_secret": { "description": "The client secret", "type": "string" }, "partner_id": { "anyOf": [ { "description": "If you are a platform with multiple partners this is the partner ID you want to get the token for. Standard partners should not provide this.", "type": "string" }, { "type": "null" } ] } }, "required": [ "client_id", "client_secret" ], "type": "object" } }, "multipart/form-data": { "schema": { "properties": { "client_id": { "description": "The client ID", "type": "string" }, "client_secret": { "description": "The client secret", "type": "string" }, "partner_id": { "anyOf": [ { "description": "If you are a platform with multiple partners this is the partner ID you want to get the token for. Standard partners should not provide this.", "type": "string" }, { "type": "null" } ] } }, "required": [ "client_id", "client_secret" ], "type": "object" } }, "text/plain": { "schema": { "properties": { "client_id": { "description": "The client ID", "type": "string" }, "client_secret": { "description": "The client secret", "type": "string" }, "partner_id": { "anyOf": [ { "description": "If you are a platform with multiple partners this is the partner ID you want to get the token for. Standard partners should not provide this.", "type": "string" }, { "type": "null" } ] } }, "required": [ "client_id", "client_secret" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_token": { "description": "The access token", "type": "string" }, "expires_in": { "description": "The expiration time of the access token", "examples": [ 86400 ], "type": "number" }, "token_type": { "description": "The type of the access token", "examples": [ "Bearer" ], "type": "string" } }, "required": [ "access_token", "expires_in", "token_type" ], "type": "object" } }, "multipart/form-data": { "schema": { "properties": { "access_token": { "description": "The access token", "type": "string" }, "expires_in": { "description": "The expiration time of the access token", "examples": [ 86400 ], "type": "number" }, "token_type": { "description": "The type of the access token", "examples": [ "Bearer" ], "type": "string" } }, "required": [ "access_token", "expires_in", "token_type" ], "type": "object" } }, "text/plain": { "schema": { "properties": { "access_token": { "description": "The access token", "type": "string" }, "expires_in": { "description": "The expiration time of the access token", "examples": [ 86400 ], "type": "number" }, "token_type": { "description": "The type of the access token", "examples": [ "Bearer" ], "type": "string" } }, "required": [ "access_token", "expires_in", "token_type" ], "type": "object" } } }, "description": "The response from the access token endpoint" } }, "summary": "Get an access token", "tags": [ "auth" ] } }, "/v1/health": { "get": { "description": "Health check", "operationId": "getV1Health", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "status": { "description": "The status of the health check", "example": "OK", "type": "string" } }, "required": [ "status" ], "type": "object" } }, "multipart/form-data": { "schema": { "properties": { "status": { "description": "The status of the health check", "example": "OK", "type": "string" } }, "required": [ "status" ], "type": "object" } }, "text/plain": { "schema": { "properties": { "status": { "description": "The status of the health check", "example": "OK", "type": "string" } }, "required": [ "status" ], "type": "object" } } }, "description": "The response from the health check" } }, "tags": [ "health" ] } }, "/v1/loans": { "post": { "operationId": "postV1Loans", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "description": "The request to create a loan application", "properties": { "borrowers": { "items": { "allOf": [ { "description": "The borrower details", "properties": { "currentAddress": { "description": "The address details", "properties": { "city": { "description": "The city of the address", "example": "San Francisco", "type": "string" }, "county": { "anyOf": [ { "description": "The county of the address", "example": "San Francisco", "type": "string" }, { "type": "null" } ] }, "state": { "description": "The state of the address", "example": "CA", "type": "string" }, "street": { "description": "The street address", "example": "123 Main St", "type": "string" }, "street2": { "anyOf": [ { "description": "The second line of the address", "example": "Apt 123", "type": "string" }, { "type": "null" } ] }, "zip": { "description": "The zip code of the address", "example": "94101", "type": "string" } }, "required": [ "street", "city", "state", "zip" ], "title": "Address", "type": "object" }, "dob": { "description": "The date of birth of the borrower", "example": "1990-01-01", "format": "date", "type": "string" }, "email": { "description": "Required for primary borrower, optional for co-borrowers", "example": "john.doe@example.com", "type": "string" }, "firstName": { "description": "The first name of the borrower.\n\n**Special behavior:** If the primary borrower's firstName is set to \"Bind_policy\" and the loan is PATCHED using the PATCH /v1/loans/shop endpoint in the sandbox environment, an HO3 policy will automatically be created and associated to the contact.", "example": "John", "type": "string" }, "formerAddress": { "anyOf": [ { "description": "The address details", "properties": { "city": { "description": "The city of the address", "example": "San Francisco", "type": "string" }, "county": { "anyOf": [ { "description": "The county of the address", "example": "San Francisco", "type": "string" }, { "type": "null" } ] }, "state": { "description": "The state of the address", "example": "CA", "type": "string" }, "street": { "description": "The street address", "example": "123 Main St", "type": "string" }, "street2": { "anyOf": [ { "description": "The second line of the address", "example": "Apt 123", "type": "string" }, { "type": "null" } ] }, "zip": { "description": "The zip code of the address", "example": "94101", "type": "string" } }, "required": [ "street", "city", "state", "zip" ], "title": "Address", "type": "object" }, { "type": "null" } ] }, "gender": { "description": "The gender of the borrower", "enum": [ "FEMALE", "MALE", "NOT_SPECIFIED" ], "example": "MALE", "type": "string" }, "isPrimary": { "description": "Whether the borrower is the primary borrower", "example": true, "type": "boolean" }, "lastName": { "description": "The last name of the borrower.\n\n**Special behavior:** If the primary borrower's lastName is set to \"Wind\", \"Dwelling_fire\", \"Flood\", or \"Earthquake\" and the loan is PATCHED using the PATCH /v1/loans/shop endpoint in the sandbox environment, a supplemental policy will also be created in the same line of business in addition to an HO3 policy and associated to the contact.", "example": "Doe", "type": "string" }, "mailingAddress": { "anyOf": [ { "description": "The address details", "properties": { "city": { "description": "The city of the address", "example": "San Francisco", "type": "string" }, "county": { "anyOf": [ { "description": "The county of the address", "example": "San Francisco", "type": "string" }, { "type": "null" } ] }, "state": { "description": "The state of the address", "example": "CA", "type": "string" }, "street": { "description": "The street address", "example": "123 Main St", "type": "string" }, "street2": { "anyOf": [ { "description": "The second line of the address", "example": "Apt 123", "type": "string" }, { "type": "null" } ] }, "zip": { "description": "The zip code of the address", "example": "94101", "type": "string" } }, "required": [ "street", "city", "state", "zip" ], "title": "Address", "type": "object" }, { "type": "null" } ] }, "maritalStatus": { "description": "The marital status of the borrower", "enum": [ "MARRIED", "NOT_PROVIDED", "SEPARATED", "SINGLE", "DIVORCED", "WIDOWED", "DOMESTIC_PARTNER" ], "example": "SINGLE", "type": "string" } }, "required": [ "firstName", "lastName", "isPrimary", "currentAddress" ], "type": "object" }, { "anyOf": [ { "properties": { "email": { "description": "The email address of the primary borrower", "example": "john.doe@example.com", "type": "string" }, "isPrimary": { "const": true, "description": "Whether the borrower is the primary borrower", "examples": [ true ], "type": "boolean" }, "phone": { "description": "The phone number of the primary borrower", "example": "1234567890", "type": "string" } }, "required": [ "isPrimary", "email", "phone" ], "title": "PrimaryBorrower", "type": "object" }, { "properties": { "email": { "anyOf": [ { "description": "The email address of the co-borrower", "example": "jane.doe@example.com", "type": "string" }, { "type": "null" } ] }, "isPrimary": { "const": false, "description": "False for co-borrowers", "examples": [ false ], "type": "boolean" }, "phone": { "anyOf": [ { "anyOf": [ { "description": "The phone number of the co-borrower", "example": "1234567890", "type": "string" }, { "const": "", "type": "string" } ] }, { "type": "null" } ] } }, "required": [ "isPrimary" ], "title": "CoBorrower", "type": "object" } ] } ] }, "type": "array" }, "closingDate": { "anyOf": [ { "description": "The closing date of the loan", "example": "2025-01-01", "format": "date", "type": "string" }, { "type": "null" } ] }, "externalId": { "anyOf": [ { "description": "An external identifier used for reference. Defaults to loanNumber", "example": "1234567890", "type": "string" }, { "type": "null" } ] }, "loanAmount": { "anyOf": [ { "description": "The loan amount", "example": 100000, "type": "number" }, { "type": "null" } ] }, "loanContacts": { "anyOf": [ { "items": { "description": "The loan contact information", "properties": { "email": { "description": "The email of the loan officer", "example": "john.doe@example.com", "type": "string" }, "firstName": { "description": "The first name of the loan officer", "example": "John", "type": "string" }, "lastName": { "description": "The last name of the loan officer", "example": "Doe", "type": "string" }, "phone": { "description": "The phone number of the loan officer", "example": "1234567890", "type": "string" }, "role": { "description": "The role of the loan contact", "example": "Loan Officer", "type": "string" } }, "required": [ "firstName", "lastName", "email", "phone", "role" ], "type": "object" }, "type": "array" }, { "type": "null" } ] }, "loanNumber": { "description": "The loan number", "example": "1234567890", "type": "string" }, "loanOfficer": { "anyOf": [ { "description": "The loan contact information", "properties": { "email": { "description": "The email of the loan officer", "example": "john.doe@example.com", "type": "string" }, "firstName": { "description": "The first name of the loan officer", "example": "John", "type": "string" }, "lastName": { "description": "The last name of the loan officer", "example": "Doe", "type": "string" }, "phone": { "description": "The phone number of the loan officer", "example": "1234567890", "type": "string" } }, "required": [ "firstName", "lastName", "email", "phone" ], "type": "object" }, { "type": "null" } ] }, "loanPurposeType": { "anyOf": [ { "description": "The purpose of the loan", "enum": [ "PURCHASE", "REFINANCE", "CONSTRUCTION", "CONSTRUCTION PERM", "MORTGAGE MODIFICATION", "LAND_LOT", "OTHER" ], "example": "PURCHASE", "type": "string" }, { "type": "null" } ] }, "loanType": { "anyOf": [ { "description": "The type of the loan", "enum": [ "MORTGAGE", "HELOC", "HELOAN", "UNKNOWN_LOAN_TYPE" ], "example": "MORTGAGE", "type": "string" }, { "type": "null" } ] }, "property": { "description": "The property details", "properties": { "address": { "description": "The address details", "properties": { "city": { "description": "The city of the address", "example": "San Francisco", "type": "string" }, "county": { "anyOf": [ { "description": "The county of the address", "example": "San Francisco", "type": "string" }, { "type": "null" } ] }, "state": { "description": "The state of the address", "example": "CA", "type": "string" }, "street": { "description": "The street address", "example": "123 Main St", "type": "string" }, "street2": { "anyOf": [ { "description": "The second line of the address", "example": "Apt 123", "type": "string" }, { "type": "null" } ] }, "zip": { "description": "The zip code of the address", "example": "94101", "type": "string" } }, "required": [ "street", "city", "state", "zip" ], "title": "Address", "type": "object" }, "dwellingInfo": { "properties": { "airConditioningType": { "description": "The type of air conditioning", "example": "Central", "type": "string" }, "annualFloodRisk": { "description": "The annual flood risk", "example": "Low", "type": "string" }, "appraisalValue": { "description": "The appraisal value", "example": 100000, "type": "number" }, "basementSquareFootage": { "description": "The square footage of the basement", "example": 1000, "type": "number" }, "buildingCondition": { "description": "The condition of the building", "example": "Good", "type": "string" }, "effectiveYearBuilt": { "description": "The effective year built", "example": "2020", "type": "string" }, "electricityType": { "description": "The type of electricity", "example": "Electric", "type": "string" }, "exteriorWallType": { "description": "The type of exterior wall", "example": "Brick", "type": "string" }, "femaFloodZone": { "description": "The FEMA flood zone", "example": "A", "type": "string" }, "fireDepartment": { "description": "The fire department", "example": "Fire Department", "type": "string" }, "fireplaceType": { "description": "The type of fireplace", "example": "Wood", "type": "string" }, "fireplaces": { "description": "The number of fireplaces", "example": 2, "type": "number" }, "flooringType": { "description": "The type of flooring", "example": "Hardwood", "type": "string" }, "foundationType": { "description": "The type of foundation", "example": "Slab", "type": "string" }, "fuelType": { "description": "The type of fuel", "example": "Electric", "type": "string" }, "garageSquareFootage": { "description": "The square footage of the garage", "example": 1000, "type": "number" }, "garageType": { "description": "The type of garage", "example": "Attached", "type": "string" }, "heatingType": { "description": "The type of heating", "example": "Central", "type": "string" }, "homeConstructionMaterial": { "description": "The construction material of the home", "example": "Wood", "type": "string" }, "homeStructureType": { "description": "The structure type of the home", "example": "WOOD_FRAME", "type": "string" }, "loanId": { "description": "The unique identifier of the loan", "example": "1234567890", "type": "string" }, "newConstruction": { "description": "Whether the home is new construction", "example": true, "type": "boolean" }, "numberOfBathrooms": { "description": "The number of bathrooms", "example": 2, "type": "number" }, "numberOfBedrooms": { "description": "The number of bedrooms", "example": 3, "type": "number" }, "numberOfFireplaces": { "description": "The number of fireplaces", "example": 2, "type": "number" }, "numberOfLivingUnits": { "description": "The number of living units", "example": 1, "type": "number" }, "numberOfStories": { "description": "The number of stories", "example": 2, "type": "number" }, "parkingType": { "description": "The type of parking", "example": "Attached", "type": "string" }, "policeDepartment": { "description": "The police department", "example": "Police Department", "type": "string" }, "poolType": { "description": "The type of pool", "example": "Pool", "type": "string" }, "propertyUsageType": { "description": "The usage type of the property", "example": "Primary Residence", "type": "string" }, "purchasePrice": { "description": "The purchase price", "example": 100000, "type": "number" }, "replacementCost": { "description": "The replacement cost", "example": 100000, "type": "number" }, "replacementCostProvider": { "description": "The provider of the replacement cost", "example": "Provider", "type": "string" }, "roofDesign": { "description": "The design of the roof", "example": "Gable", "type": "string" }, "roofMaterial": { "description": "The material of the roof", "example": "Asphalt", "type": "string" }, "roofStyleType": { "description": "The style type of the roof", "example": "Hip", "type": "string" }, "sewerType": { "description": "The type of sewer", "example": "Septic", "type": "string" }, "squareFootage": { "description": "The square footage of the property", "example": 1000, "type": "number" }, "storiesWithCode": { "description": "The number of stories with code", "example": "2+A", "type": "string" }, "waterType": { "description": "The type of water", "example": "Well", "type": "string" }, "yearBuilt": { "description": "The year built", "example": "2020", "type": "string" } }, "type": "object" }, "type": { "description": "The type of the property", "enum": [ "SINGLE_FAMILY", "CONDOMINIUM", "TOWNHOUSE", "TWO_TO_FOUR_UNIT_PROPERTY", "COOPERATIVE", "MULTIFAMILY", "MANUFACTURED_OR_MOBILE_HOME", "MANUFACTURED_HOME", "COMMERCIAL_NON_RESIDENTIAL", "MIXED_USE_RESIDENTIAL", "FARM", "HOME_AND_BUSINESS_COMBINED", "LAND", "BARE_LAND", "AGRICULTURAL_LAND", "RECREATIONAL_LAND", "IMPROVED_LAND", "OTHER_LAND" ], "example": "SINGLE_FAMILY", "type": "string" }, "usage": { "description": "The usage of the property", "enum": [ "PRIMARY_RESIDENCE", "SECOND_HOME", "PRIMARY_AND_INVESTMENT", "INVESTMENT", "FHA_SECONDARY_RESIDENCE" ], "example": "PRIMARY_RESIDENCE", "type": "string" } }, "required": [ "address", "type", "usage", "dwellingInfo" ], "title": "Property", "type": "object" } }, "required": [ "loanNumber", "borrowers", "property" ], "type": "object" } }, "multipart/form-data": { "schema": { "description": "The request to create a loan application", "properties": { "borrowers": { "items": { "allOf": [ { "description": "The borrower details", "properties": { "currentAddress": { "description": "The address details", "properties": { "city": { "description": "The city of the address", "example": "San Francisco", "type": "string" }, "county": { "anyOf": [ { "description": "The county of the address", "example": "San Francisco", "type": "string" }, { "type": "null" } ] }, "state": { "description": "The state of the address", "example": "CA", "type": "string" }, "street": { "description": "The street address", "example": "123 Main St", "type": "string" }, "street2": { "anyOf": [ { "description": "The second line of the address", "example": "Apt 123", "type": "string" }, { "type": "null" } ] }, "zip": { "description": "The zip code of the address", "example": "94101", "type": "string" } }, "required": [ "street", "city", "state", "zip" ], "title": "Address", "type": "object" }, "dob": { "description": "The date of birth of the borrower", "example": "1990-01-01", "format": "date", "type": "string" }, "email": { "description": "Required for primary borrower, optional for co-borrowers", "example": "john.doe@example.com", "type": "string" }, "firstName": { "description": "The first name of the borrower.\n\n**Special behavior:** If the primary borrower's firstName is set to \"Bind_policy\" and the loan is PATCHED using the PATCH /v1/loans/shop endpoint in the sandbox environment, an HO3 policy will automatically be created and associated to the contact.", "example": "John", "type": "string" }, "formerAddress": { "anyOf": [ { "description": "The address details", "properties": { "city": { "description": "The city of the address", "example": "San Francisco", "type": "string" }, "county": { "anyOf": [ { "description": "The county of the address", "example": "San Francisco", "type": "string" }, { "type": "null" } ] }, "state": { "description": "The state of the address", "example": "CA", "type": "string" }, "street": { "description": "The street address", "example": "123 Main St", "type": "string" }, "street2": { "anyOf": [ { "description": "The second line of the address", "example": "Apt 123", "type": "string" }, { "type": "null" } ] }, "zip": { "description": "The zip code of the address", "example": "94101", "type": "string" } }, "required": [ "street", "city", "state", "zip" ], "title": "Address", "type": "object" }, { "type": "null" } ] }, "gender": { "description": "The gender of the borrower", "enum": [ "FEMALE", "MALE", "NOT_SPECIFIED" ], "example": "MALE", "type": "string" }, "isPrimary": { "description": "Whether the borrower is the primary borrower", "example": true, "type": "boolean" }, "lastName": { "description": "The last name of the borrower.\n\n**Special behavior:** If the primary borrower's lastName is set to \"Wind\", \"Dwelling_fire\", \"Flood\", or \"Earthquake\" and the loan is PATCHED using the PATCH /v1/loans/shop endpoint in the sandbox environment, a supplemental policy will also be created in the same line of business in addition to an HO3 policy and associated to the contact.", "example": "Doe", "type": "string" }, "mailingAddress": { "anyOf": [ { "description": "The address details", "properties": { "city": { "description": "The city of the address", "example": "San Francisco", "type": "string" }, "county": { "anyOf": [ { "description": "The county of the address", "example": "San Francisco", "type": "string" }, { "type": "null" } ] }, "state": { "description": "The state of the address", "example": "CA", "type": "string" }, "street": { "description": "The street address", "example": "123 Main St", "type": "string" }, "street2": { "anyOf": [ { "description": "The second line of the address", "example": "Apt 123", "type": "string" }, { "type": "null" } ] }, "zip": { "description": "The zip code of the address", "example": "94101", "type": "string" } }, "required": [ "street", "city", "state", "zip" ], "title": "Address", "type": "object" }, { "type": "null" } ] }, "maritalStatus": { "description": "The marital status of the borrower", "enum": [ "MARRIED", "NOT_PROVIDED", "SEPARATED", "SINGLE", "DIVORCED", "WIDOWED", "DOMESTIC_PARTNER" ], "example": "SINGLE", "type": "string" } }, "required": [ "firstName", "lastName", "isPrimary", "currentAddress" ], "type": "object" }, { "anyOf": [ { "properties": { "email": { "description": "The email address of the primary borrower", "example": "john.doe@example.com", "type": "string" }, "isPrimary": { "const": true, "description": "Whether the borrower is the primary borrower", "examples": [ true ], "type": "boolean" }, "phone": { "description": "The phone number of the primary borrower", "example": "1234567890", "type": "string" } }, "required": [ "isPrimary", "email", "phone" ], "title": "PrimaryBorrower", "type": "object" }, { "properties": { "email": { "anyOf": [ { "description": "The email address of the co-borrower", "example": "jane.doe@example.com", "type": "string" }, { "type": "null" } ] }, "isPrimary": { "const": false, "description": "False for co-borrowers", "examples": [ false ], "type": "boolean" }, "phone": { "anyOf": [ { "anyOf": [ { "description": "The phone number of the co-borrower", "example": "1234567890", "type": "string" }, { "const": "", "type": "string" } ] }, { "type": "null" } ] } }, "required": [ "isPrimary" ], "title": "CoBorrower", "type": "object" } ] } ] }, "type": "array" }, "closingDate": { "anyOf": [ { "description": "The closing date of the loan", "example": "2025-01-01", "format": "date", "type": "string" }, { "type": "null" } ] }, "externalId": { "anyOf": [ { "description": "An external identifier used for reference. Defaults to loanNumber", "example": "1234567890", "type": "string" }, { "type": "null" } ] }, "loanAmount": { "anyOf": [ { "description": "The loan amount", "example": 100000, "type": "number" }, { "type": "null" } ] }, "loanContacts": { "anyOf": [ { "items": { "description": "The loan contact information", "properties": { "email": { "description": "The email of the loan officer", "example": "john.doe@example.com", "type": "string" }, "firstName": { "description": "The first name of the loan officer", "example": "John", "type": "string" }, "lastName": { "description": "The last name of the loan officer", "example": "Doe", "type": "string" }, "phone": { "description": "The phone number of the loan officer", "example": "1234567890", "type": "string" }, "role": { "description": "The role of the loan contact", "example": "Loan Officer", "type": "string" } }, "required": [ "firstName", "lastName", "email", "phone", "role" ], "type": "object" }, "type": "array" }, { "type": "null" } ] }, "loanNumber": { "description": "The loan number", "example": "1234567890", "type": "string" }, "loanOfficer": { "anyOf": [ { "description": "The loan contact information", "properties": { "email": { "description": "The email of the loan officer", "example": "john.doe@example.com", "type": "string" }, "firstName": { "description": "The first name of the loan officer", "example": "John", "type": "string" }, "lastName": { "description": "The last name of the loan officer", "example": "Doe", "type": "string" }, "phone": { "description": "The phone number of the loan officer", "example": "1234567890", "type": "string" } }, "required": [ "firstName", "lastName", "email", "phone" ], "type": "object" }, { "type": "null" } ] }, "loanPurposeType": { "anyOf": [ { "description": "The purpose of the loan", "enum": [ "PURCHASE", "REFINANCE", "CONSTRUCTION", "CONSTRUCTION PERM", "MORTGAGE MODIFICATION", "LAND_LOT", "OTHER" ], "example": "PURCHASE", "type": "string" }, { "type": "null" } ] }, "loanType": { "anyOf": [ { "description": "The type of the loan", "enum": [ "MORTGAGE", "HELOC", "HELOAN", "UNKNOWN_LOAN_TYPE" ], "example": "MORTGAGE", "type": "string" }, { "type": "null" } ] }, "property": { "description": "The property details", "properties": { "address": { "description": "The address details", "properties": { "city": { "description": "The city of the address", "example": "San Francisco", "type": "string" }, "county": { "anyOf": [ { "description": "The county of the address", "example": "San Francisco", "type": "string" }, { "type": "null" } ] }, "state": { "description": "The state of the address", "example": "CA", "type": "string" }, "street": { "description": "The street address", "example": "123 Main St", "type": "string" }, "street2": { "anyOf": [ { "description": "The second line of the address", "example": "Apt 123", "type": "string" }, { "type": "null" } ] }, "zip": { "description": "The zip code of the address", "example": "94101", "type": "string" } }, "required": [ "street", "city", "state", "zip" ], "title": "Address", "type": "object" }, "dwellingInfo": { "properties": { "airConditioningType": { "description": "The type of air conditioning", "example": "Central", "type": "string" }, "annualFloodRisk": { "description": "The annual flood risk", "example": "Low", "type": "string" }, "appraisalValue": { "description": "The appraisal value", "example": 100000, "type": "number" }, "basementSquareFootage": { "description": "The square footage of the basement", "example": 1000, "type": "number" }, "buildingCondition": { "description": "The condition of the building", "example": "Good", "type": "string" }, "effectiveYearBuilt": { "description": "The effective year built", "example": "2020", "type": "string" }, "electricityType": { "description": "The type of electricity", "example": "Electric", "type": "string" }, "exteriorWallType": { "description": "The type of exterior wall", "example": "Brick", "type": "string" }, "femaFloodZone": { "description": "The FEMA flood zone", "example": "A", "type": "string" }, "fireDepartment": { "description": "The fire department", "example": "Fire Department", "type": "string" }, "fireplaceType": { "description": "The type of fireplace", "example": "Wood", "type": "string" }, "fireplaces": { "description": "The number of fireplaces", "example": 2, "type": "number" }, "flooringType": { "description": "The type of flooring", "example": "Hardwood", "type": "string" }, "foundationType": { "description": "The type of foundation", "example": "Slab", "type": "string" }, "fuelType": { "description": "The type of fuel", "example": "Electric", "type": "string" }, "garageSquareFootage": { "description": "The square footage of the garage", "example": 1000, "type": "number" }, "garageType": { "description": "The type of garage", "example": "Attached", "type": "string" }, "heatingType": { "description": "The type of heating", "example": "Central", "type": "string" }, "homeConstructionMaterial": { "description": "The construction material of the home", "example": "Wood", "type": "string" }, "homeStructureType": { "description": "The structure type of the home", "example": "WOOD_FRAME", "type": "string" }, "loanId": { "description": "The unique identifier of the loan", "example": "1234567890", "type": "string" }, "newConstruction": { "description": "Whether the home is new construction", "example": true, "type": "boolean" }, "numberOfBathrooms": { "description": "The number of bathrooms", "example": 2, "type": "number" }, "numberOfBedrooms": { "description": "The number of bedrooms", "example": 3, "type": "number" }, "numberOfFireplaces": { "description": "The number of fireplaces", "example": 2, "type": "number" }, "numberOfLivingUnits": { "description": "The number of living units", "example": 1, "type": "number" }, "numberOfStories": { "description": "The number of stories", "example": 2, "type": "number" }, "parkingType": { "description": "The type of parking", "example": "Attached", "type": "string" }, "policeDepartment": { "description": "The police department", "example": "Police Department", "type": "string" }, "poolType": { "description": "The type of pool", "example": "Pool", "type": "string" }, "propertyUsageType": { "description": "The usage type of the property", "example": "Primary Residence", "type": "string" }, "purchasePrice": { "description": "The purchase price", "example": 100000, "type": "number" }, "replacementCost": { "description": "The replacement cost", "example": 100000, "type": "number" }, "replacementCostProvider": { "description": "The provider of the replacement cost", "example": "Provider", "type": "string" }, "roofDesign": { "description": "The design of the roof", "example": "Gable", "type": "string" }, "roofMaterial": { "description": "The material of the roof", "example": "Asphalt", "type": "string" }, "roofStyleType": { "description": "The style type of the roof", "example": "Hip", "type": "string" }, "sewerType": { "description": "The type of sewer", "example": "Septic", "type": "string" }, "squareFootage": { "description": "The square footage of the property", "example": 1000, "type": "number" }, "storiesWithCode": { "description": "The number of stories with code", "example": "2+A", "type": "string" }, "waterType": { "description": "The type of water", "example": "Well", "type": "string" }, "yearBuilt": { "description": "The year built", "example": "2020", "type": "string" } }, "type": "object" }, "type": { "description": "The type of the property", "enum": [ "SINGLE_FAMILY", "CONDOMINIUM", "TOWNHOUSE", "TWO_TO_FOUR_UNIT_PROPERTY", "COOPERATIVE", "MULTIFAMILY", "MANUFACTURED_OR_MOBILE_HOME", "MANUFACTURED_HOME", "COMMERCIAL_NON_RESIDENTIAL", "MIXED_USE_RESIDENTIAL", "FARM", "HOME_AND_BUSINESS_COMBINED", "LAND", "BARE_LAND", "AGRICULTURAL_LAND", "RECREATIONAL_LAND", "IMPROVED_LAND", "OTHER_LAND" ], "example": "SINGLE_FAMILY", "type": "string" }, "usage": { "description": "The usage of the property", "enum": [ "PRIMARY_RESIDENCE", "SECOND_HOME", "PRIMARY_AND_INVESTMENT", "INVESTMENT", "FHA_SECONDARY_RESIDENCE" ], "example": "PRIMARY_RESIDENCE", "type": "string" } }, "required": [ "address", "type", "usage", "dwellingInfo" ], "title": "Property", "type": "object" } }, "required": [ "loanNumber", "borrowers", "property" ], "type": "object" } }, "text/plain": { "schema": { "description": "The request to create a loan application", "properties": { "borrowers": { "items": { "allOf": [ { "description": "The borrower details", "properties": { "currentAddress": { "description": "The address details", "properties": { "city": { "description": "The city of the address", "example": "San Francisco", "type": "string" }, "county": { "anyOf": [ { "description": "The county of the address", "example": "San Francisco", "type": "string" }, { "type": "null" } ] }, "state": { "description": "The state of the address", "example": "CA", "type": "string" }, "street": { "description": "The street address", "example": "123 Main St", "type": "string" }, "street2": { "anyOf": [ { "description": "The second line of the address", "example": "Apt 123", "type": "string" }, { "type": "null" } ] }, "zip": { "description": "The zip code of the address", "example": "94101", "type": "string" } }, "required": [ "street", "city", "state", "zip" ], "title": "Address", "type": "object" }, "dob": { "description": "The date of birth of the borrower", "example": "1990-01-01", "format": "date", "type": "string" }, "email": { "description": "Required for primary borrower, optional for co-borrowers", "example": "john.doe@example.com", "type": "string" }, "firstName": { "description": "The first name of the borrower.\n\n**Special behavior:** If the primary borrower's firstName is set to \"Bind_policy\" and the loan is PATCHED using the PATCH /v1/loans/shop endpoint in the sandbox environment, an HO3 policy will automatically be created and associated to the contact.", "example": "John", "type": "string" }, "formerAddress": { "anyOf": [ { "description": "The address details", "properties": { "city": { "description": "The city of the address", "example": "San Francisco", "type": "string" }, "county": { "anyOf": [ { "description": "The county of the address", "example": "San Francisco", "type": "string" }, { "type": "null" } ] }, "state": { "description": "The state of the address", "example": "CA", "type": "string" }, "street": { "description": "The street address", "example": "123 Main St", "type": "string" }, "street2": { "anyOf": [ { "description": "The second line of the address", "example": "Apt 123", "type": "string" }, { "type": "null" } ] }, "zip": { "description": "The zip code of the address", "example": "94101", "type": "string" } }, "required": [ "street", "city", "state", "zip" ], "title": "Address", "type": "object" }, { "type": "null" } ] }, "gender": { "description": "The gender of the borrower", "enum": [ "FEMALE", "MALE", "NOT_SPECIFIED" ], "example": "MALE", "type": "string" }, "isPrimary": { "description": "Whether the borrower is the primary borrower", "example": true, "type": "boolean" }, "lastName": { "description": "The last name of the borrower.\n\n**Special behavior:** If the primary borrower's lastName is set to \"Wind\", \"Dwelling_fire\", \"Flood\", or \"Earthquake\" and the loan is PATCHED using the PATCH /v1/loans/shop endpoint in the sandbox environment, a supplemental policy will also be created in the same line of business in addition to an HO3 policy and associated to the contact.", "example": "Doe", "type": "string" }, "mailingAddress": { "anyOf": [ { "description": "The address details", "properties": { "city": { "description": "The city of the address", "example": "San Francisco", "type": "string" }, "county": { "anyOf": [ { "description": "The county of the address", "example": "San Francisco", "type": "string" }, { "type": "null" } ] }, "state": { "description": "The state of the address", "example": "CA", "type": "string" }, "street": { "description": "The street address", "example": "123 Main St", "type": "string" }, "street2": { "anyOf": [ { "description": "The second line of the address", "example": "Apt 123", "type": "string" }, { "type": "null" } ] }, "zip": { "description": "The zip code of the address", "example": "94101", "type": "string" } }, "required": [ "street", "city", "state", "zip" ], "title": "Address", "type": "object" }, { "type": "null" } ] }, "maritalStatus": { "description": "The marital status of the borrower", "enum": [ "MARRIED", "NOT_PROVIDED", "SEPARATED", "SINGLE", "DIVORCED", "WIDOWED", "DOMESTIC_PARTNER" ], "example": "SINGLE", "type": "string" } }, "required": [ "firstName", "lastName", "isPrimary", "currentAddress" ], "type": "object" }, { "anyOf": [ { "properties": { "email": { "description": "The email address of the primary borrower", "example": "john.doe@example.com", "type": "string" }, "isPrimary": { "const": true, "description": "Whether the borrower is the primary borrower", "examples": [ true ], "type": "boolean" }, "phone": { "description": "The phone number of the primary borrower", "example": "1234567890", "type": "string" } }, "required": [ "isPrimary", "email", "phone" ], "title": "PrimaryBorrower", "type": "object" }, { "properties": { "email": { "anyOf": [ { "description": "The email address of the co-borrower", "example": "jane.doe@example.com", "type": "string" }, { "type": "null" } ] }, "isPrimary": { "const": false, "description": "False for co-borrowers", "examples": [ false ], "type": "boolean" }, "phone": { "anyOf": [ { "anyOf": [ { "description": "The phone number of the co-borrower", "example": "1234567890", "type": "string" }, { "const": "", "type": "string" } ] }, { "type": "null" } ] } }, "required": [ "isPrimary" ], "title": "CoBorrower", "type": "object" } ] } ] }, "type": "array" }, "closingDate": { "anyOf": [ { "description": "The closing date of the loan", "example": "2025-01-01", "format": "date", "type": "string" }, { "type": "null" } ] }, "externalId": { "anyOf": [ { "description": "An external identifier used for reference. Defaults to loanNumber", "example": "1234567890", "type": "string" }, { "type": "null" } ] }, "loanAmount": { "anyOf": [ { "description": "The loan amount", "example": 100000, "type": "number" }, { "type": "null" } ] }, "loanContacts": { "anyOf": [ { "items": { "description": "The loan contact information", "properties": { "email": { "description": "The email of the loan officer", "example": "john.doe@example.com", "type": "string" }, "firstName": { "description": "The first name of the loan officer", "example": "John", "type": "string" }, "lastName": { "description": "The last name of the loan officer", "example": "Doe", "type": "string" }, "phone": { "description": "The phone number of the loan officer", "example": "1234567890", "type": "string" }, "role": { "description": "The role of the loan contact", "example": "Loan Officer", "type": "string" } }, "required": [ "firstName", "lastName", "email", "phone", "role" ], "type": "object" }, "type": "array" }, { "type": "null" } ] }, "loanNumber": { "description": "The loan number", "example": "1234567890", "type": "string" }, "loanOfficer": { "anyOf": [ { "description": "The loan contact information", "properties": { "email": { "description": "The email of the loan officer", "example": "john.doe@example.com", "type": "string" }, "firstName": { "description": "The first name of the loan officer", "example": "John", "type": "string" }, "lastName": { "description": "The last name of the loan officer", "example": "Doe", "type": "string" }, "phone": { "description": "The phone number of the loan officer", "example": "1234567890", "type": "string" } }, "required": [ "firstName", "lastName", "email", "phone" ], "type": "object" }, { "type": "null" } ] }, "loanPurposeType": { "anyOf": [ { "description": "The purpose of the loan", "enum": [ "PURCHASE", "REFINANCE", "CONSTRUCTION", "CONSTRUCTION PERM", "MORTGAGE MODIFICATION", "LAND_LOT", "OTHER" ], "example": "PURCHASE", "type": "string" }, { "type": "null" } ] }, "loanType": { "anyOf": [ { "description": "The type of the loan", "enum": [ "MORTGAGE", "HELOC", "HELOAN", "UNKNOWN_LOAN_TYPE" ], "example": "MORTGAGE", "type": "string" }, { "type": "null" } ] }, "property": { "description": "The property details", "properties": { "address": { "description": "The address details", "properties": { "city": { "description": "The city of the address", "example": "San Francisco", "type": "string" }, "county": { "anyOf": [ { "description": "The county of the address", "example": "San Francisco", "type": "string" }, { "type": "null" } ] }, "state": { "description": "The state of the address", "example": "CA", "type": "string" }, "street": { "description": "The street address", "example": "123 Main St", "type": "string" }, "street2": { "anyOf": [ { "description": "The second line of the address", "example": "Apt 123", "type": "string" }, { "type": "null" } ] }, "zip": { "description": "The zip code of the address", "example": "94101", "type": "string" } }, "required": [ "street", "city", "state", "zip" ], "title": "Address", "type": "object" }, "dwellingInfo": { "properties": { "airConditioningType": { "description": "The type of air conditioning", "example": "Central", "type": "string" }, "annualFloodRisk": { "description": "The annual flood risk", "example": "Low", "type": "string" }, "appraisalValue": { "description": "The appraisal value", "example": 100000, "type": "number" }, "basementSquareFootage": { "description": "The square footage of the basement", "example": 1000, "type": "number" }, "buildingCondition": { "description": "The condition of the building", "example": "Good", "type": "string" }, "effectiveYearBuilt": { "description": "The effective year built", "example": "2020", "type": "string" }, "electricityType": { "description": "The type of electricity", "example": "Electric", "type": "string" }, "exteriorWallType": { "description": "The type of exterior wall", "example": "Brick", "type": "string" }, "femaFloodZone": { "description": "The FEMA flood zone", "example": "A", "type": "string" }, "fireDepartment": { "description": "The fire department", "example": "Fire Department", "type": "string" }, "fireplaceType": { "description": "The type of fireplace", "example": "Wood", "type": "string" }, "fireplaces": { "description": "The number of fireplaces", "example": 2, "type": "number" }, "flooringType": { "description": "The type of flooring", "example": "Hardwood", "type": "string" }, "foundationType": { "description": "The type of foundation", "example": "Slab", "type": "string" }, "fuelType": { "description": "The type of fuel", "example": "Electric", "type": "string" }, "garageSquareFootage": { "description": "The square footage of the garage", "example": 1000, "type": "number" }, "garageType": { "description": "The type of garage", "example": "Attached", "type": "string" }, "heatingType": { "description": "The type of heating", "example": "Central", "type": "string" }, "homeConstructionMaterial": { "description": "The construction material of the home", "example": "Wood", "type": "string" }, "homeStructureType": { "description": "The structure type of the home", "example": "WOOD_FRAME", "type": "string" }, "loanId": { "description": "The unique identifier of the loan", "example": "1234567890", "type": "string" }, "newConstruction": { "description": "Whether the home is new construction", "example": true, "type": "boolean" }, "numberOfBathrooms": { "description": "The number of bathrooms", "example": 2, "type": "number" }, "numberOfBedrooms": { "description": "The number of bedrooms", "example": 3, "type": "number" }, "numberOfFireplaces": { "description": "The number of fireplaces", "example": 2, "type": "number" }, "numberOfLivingUnits": { "description": "The number of living units", "example": 1, "type": "number" }, "numberOfStories": { "description": "The number of stories", "example": 2, "type": "number" }, "parkingType": { "description": "The type of parking", "example": "Attached", "type": "string" }, "policeDepartment": { "description": "The police department", "example": "Police Department", "type": "string" }, "poolType": { "description": "The type of pool", "example": "Pool", "type": "string" }, "propertyUsageType": { "description": "The usage type of the property", "example": "Primary Residence", "type": "string" }, "purchasePrice": { "description": "The purchase price", "example": 100000, "type": "number" }, "replacementCost": { "description": "The replacement cost", "example": 100000, "type": "number" }, "replacementCostProvider": { "description": "The provider of the replacement cost", "example": "Provider", "type": "string" }, "roofDesign": { "description": "The design of the roof", "example": "Gable", "type": "string" }, "roofMaterial": { "description": "The material of the roof", "example": "Asphalt", "type": "string" }, "roofStyleType": { "description": "The style type of the roof", "example": "Hip", "type": "string" }, "sewerType": { "description": "The type of sewer", "example": "Septic", "type": "string" }, "squareFootage": { "description": "The square footage of the property", "example": 1000, "type": "number" }, "storiesWithCode": { "description": "The number of stories with code", "example": "2+A", "type": "string" }, "waterType": { "description": "The type of water", "example": "Well", "type": "string" }, "yearBuilt": { "description": "The year built", "example": "2020", "type": "string" } }, "type": "object" }, "type": { "description": "The type of the property", "enum": [ "SINGLE_FAMILY", "CONDOMINIUM", "TOWNHOUSE", "TWO_TO_FOUR_UNIT_PROPERTY", "COOPERATIVE", "MULTIFAMILY", "MANUFACTURED_OR_MOBILE_HOME", "MANUFACTURED_HOME", "COMMERCIAL_NON_RESIDENTIAL", "MIXED_USE_RESIDENTIAL", "FARM", "HOME_AND_BUSINESS_COMBINED", "LAND", "BARE_LAND", "AGRICULTURAL_LAND", "RECREATIONAL_LAND", "IMPROVED_LAND", "OTHER_LAND" ], "example": "SINGLE_FAMILY", "type": "string" }, "usage": { "description": "The usage of the property", "enum": [ "PRIMARY_RESIDENCE", "SECOND_HOME", "PRIMARY_AND_INVESTMENT", "INVESTMENT", "FHA_SECONDARY_RESIDENCE" ], "example": "PRIMARY_RESIDENCE", "type": "string" } }, "required": [ "address", "type", "usage", "dwellingInfo" ], "title": "Property", "type": "object" } }, "required": [ "loanNumber", "borrowers", "property" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "contactPageUrl": { "description": "URL for the contact page for this loan application", "format": "uri", "type": "string" }, "hostedDisplayUrl": { "type": "string" }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "shortHostedDisplayUrl": { "description": "Short URL for the hosted borrower quote experience, when available", "format": "uri", "type": "string" }, "status": { "type": "string" } }, "required": [ "id", "status", "hostedDisplayUrl" ], "type": "object" } }, "multipart/form-data": { "schema": { "properties": { "contactPageUrl": { "description": "URL for the contact page for this loan application", "format": "uri", "type": "string" }, "hostedDisplayUrl": { "type": "string" }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "shortHostedDisplayUrl": { "description": "Short URL for the hosted borrower quote experience, when available", "format": "uri", "type": "string" }, "status": { "type": "string" } }, "required": [ "id", "status", "hostedDisplayUrl" ], "type": "object" } }, "text/plain": { "schema": { "properties": { "contactPageUrl": { "description": "URL for the contact page for this loan application", "format": "uri", "type": "string" }, "hostedDisplayUrl": { "type": "string" }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "shortHostedDisplayUrl": { "description": "Short URL for the hosted borrower quote experience, when available", "format": "uri", "type": "string" }, "status": { "type": "string" } }, "required": [ "id", "status", "hostedDisplayUrl" ], "type": "object" } } }, "description": "The response from the create loan application endpoint" } }, "security": [ { "bearerAuth": [] } ], "tags": [ "loans" ] } }, "/v1/loans/call-me-now": { "post": { "description": "Request to call now, regarding a loan application", "operationId": "postV1LoansCall-me-now", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "description": "Request to call now, regarding a loan application", "properties": { "loanId": { "default": "", "description": "Loan ID to schedule a call regarding", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "format": "uuid", "type": "string" }, "phoneNumber": { "description": "The phone number for the call", "example": "1234567890", "type": "string" } }, "required": [ "loanId", "phoneNumber" ], "type": "object" } }, "multipart/form-data": { "schema": { "description": "Request to call now, regarding a loan application", "properties": { "loanId": { "default": "", "description": "Loan ID to schedule a call regarding", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "format": "uuid", "type": "string" }, "phoneNumber": { "description": "The phone number for the call", "example": "1234567890", "type": "string" } }, "required": [ "loanId", "phoneNumber" ], "type": "object" } }, "text/plain": { "schema": { "description": "Request to call now, regarding a loan application", "properties": { "loanId": { "default": "", "description": "Loan ID to schedule a call regarding", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "format": "uuid", "type": "string" }, "phoneNumber": { "description": "The phone number for the call", "example": "1234567890", "type": "string" } }, "required": [ "loanId", "phoneNumber" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "multipart/form-data": { "schema": { "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "text/plain": { "schema": { "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "type": "object" } } }, "description": "Response for call request" } }, "security": [ { "bearerAuth": [] } ], "summary": "Call Me Now", "tags": [ "loans" ] } }, "/v1/loans/consent": { "post": { "operationId": "postV1LoansConsent", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "description": "The request to record consent", "properties": { "email": { "description": "Borrower email (optional)", "example": "email@example.com", "type": "string" }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "phone": { "description": "Borrower phone number (optional)", "example": "6666666666", "type": "string" }, "termsOfServiceId": { "description": "Loan Platform version identifier of Terms of Service", "example": "1.0", "type": "string" } }, "required": [ "id", "termsOfServiceId" ], "type": "object" } }, "multipart/form-data": { "schema": { "description": "The request to record consent", "properties": { "email": { "description": "Borrower email (optional)", "example": "email@example.com", "type": "string" }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "phone": { "description": "Borrower phone number (optional)", "example": "6666666666", "type": "string" }, "termsOfServiceId": { "description": "Loan Platform version identifier of Terms of Service", "example": "1.0", "type": "string" } }, "required": [ "id", "termsOfServiceId" ], "type": "object" } }, "text/plain": { "schema": { "description": "The request to record consent", "properties": { "email": { "description": "Borrower email (optional)", "example": "email@example.com", "type": "string" }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "phone": { "description": "Borrower phone number (optional)", "example": "6666666666", "type": "string" }, "termsOfServiceId": { "description": "Loan Platform version identifier of Terms of Service", "example": "1.0", "type": "string" } }, "required": [ "id", "termsOfServiceId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "consent": { "description": "Whether consent was successfully recorded", "example": true, "type": "boolean" }, "consentDateTime": { "description": "Consent timestamp", "example": "2023-12-25T10:30:00", "format": "date", "type": "string" }, "email": { "description": "Borrower email (optional)", "example": "email@example.com", "type": "string" }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "phone": { "description": "Borrower phone number (optional)", "example": "6666666666", "type": "string" }, "termsOfServiceId": { "description": "Loan Platform version identifier of Terms of Service", "example": "1.0", "type": "string" } }, "required": [ "consent", "consentDateTime" ], "type": "object" } }, "multipart/form-data": { "schema": { "properties": { "consent": { "description": "Whether consent was successfully recorded", "example": true, "type": "boolean" }, "consentDateTime": { "description": "Consent timestamp", "example": "2023-12-25T10:30:00", "format": "date", "type": "string" }, "email": { "description": "Borrower email (optional)", "example": "email@example.com", "type": "string" }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "phone": { "description": "Borrower phone number (optional)", "example": "6666666666", "type": "string" }, "termsOfServiceId": { "description": "Loan Platform version identifier of Terms of Service", "example": "1.0", "type": "string" } }, "required": [ "consent", "consentDateTime" ], "type": "object" } }, "text/plain": { "schema": { "properties": { "consent": { "description": "Whether consent was successfully recorded", "example": true, "type": "boolean" }, "consentDateTime": { "description": "Consent timestamp", "example": "2023-12-25T10:30:00", "format": "date", "type": "string" }, "email": { "description": "Borrower email (optional)", "example": "email@example.com", "type": "string" }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "phone": { "description": "Borrower phone number (optional)", "example": "6666666666", "type": "string" }, "termsOfServiceId": { "description": "Loan Platform version identifier of Terms of Service", "example": "1.0", "type": "string" } }, "required": [ "consent", "consentDateTime" ], "type": "object" } } }, "description": "The response to recording consent" } }, "security": [ { "bearerAuth": [] } ], "tags": [ "loans" ] } }, "/v1/loans/consent/general": { "post": { "description": "Record general consent for a loan application", "operationId": "postV1LoansConsentGeneral", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "description": "The request to record consent", "properties": { "email": { "description": "Borrower email (optional)", "example": "email@example.com", "type": "string" }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "phone": { "description": "Borrower phone number (optional)", "example": "6666666666", "type": "string" }, "termsOfServiceId": { "description": "Loan Platform version identifier of Terms of Service", "example": "1.0", "type": "string" } }, "required": [ "id", "termsOfServiceId" ], "type": "object" } }, "multipart/form-data": { "schema": { "description": "The request to record consent", "properties": { "email": { "description": "Borrower email (optional)", "example": "email@example.com", "type": "string" }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "phone": { "description": "Borrower phone number (optional)", "example": "6666666666", "type": "string" }, "termsOfServiceId": { "description": "Loan Platform version identifier of Terms of Service", "example": "1.0", "type": "string" } }, "required": [ "id", "termsOfServiceId" ], "type": "object" } }, "text/plain": { "schema": { "description": "The request to record consent", "properties": { "email": { "description": "Borrower email (optional)", "example": "email@example.com", "type": "string" }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "phone": { "description": "Borrower phone number (optional)", "example": "6666666666", "type": "string" }, "termsOfServiceId": { "description": "Loan Platform version identifier of Terms of Service", "example": "1.0", "type": "string" } }, "required": [ "id", "termsOfServiceId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "consent": { "description": "Whether consent was successfully recorded", "example": true, "type": "boolean" }, "consentDateTime": { "description": "Consent timestamp", "example": "2023-12-25T10:30:00", "format": "date", "type": "string" }, "email": { "description": "Borrower email (optional)", "example": "email@example.com", "type": "string" }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "phone": { "description": "Borrower phone number (optional)", "example": "6666666666", "type": "string" }, "termsOfServiceId": { "description": "Loan Platform version identifier of Terms of Service", "example": "1.0", "type": "string" } }, "required": [ "consent", "consentDateTime" ], "type": "object" } }, "multipart/form-data": { "schema": { "properties": { "consent": { "description": "Whether consent was successfully recorded", "example": true, "type": "boolean" }, "consentDateTime": { "description": "Consent timestamp", "example": "2023-12-25T10:30:00", "format": "date", "type": "string" }, "email": { "description": "Borrower email (optional)", "example": "email@example.com", "type": "string" }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "phone": { "description": "Borrower phone number (optional)", "example": "6666666666", "type": "string" }, "termsOfServiceId": { "description": "Loan Platform version identifier of Terms of Service", "example": "1.0", "type": "string" } }, "required": [ "consent", "consentDateTime" ], "type": "object" } }, "text/plain": { "schema": { "properties": { "consent": { "description": "Whether consent was successfully recorded", "example": true, "type": "boolean" }, "consentDateTime": { "description": "Consent timestamp", "example": "2023-12-25T10:30:00", "format": "date", "type": "string" }, "email": { "description": "Borrower email (optional)", "example": "email@example.com", "type": "string" }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "phone": { "description": "Borrower phone number (optional)", "example": "6666666666", "type": "string" }, "termsOfServiceId": { "description": "Loan Platform version identifier of Terms of Service", "example": "1.0", "type": "string" } }, "required": [ "consent", "consentDateTime" ], "type": "object" } } }, "description": "The response to recording consent" } }, "security": [ { "bearerAuth": [] } ], "summary": "Record General Consent", "tags": [ "loans" ] } }, "/v1/loans/consent/tcpa": { "post": { "description": "Record TCPA consent for a loan application", "operationId": "postV1LoansConsentTcpa", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "description": "The request to record consent", "properties": { "email": { "description": "Borrower email (optional)", "example": "email@example.com", "type": "string" }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "phone": { "description": "Borrower phone number (optional)", "example": "6666666666", "type": "string" }, "termsOfServiceId": { "description": "Loan Platform version identifier of Terms of Service", "example": "1.0", "type": "string" } }, "required": [ "id", "termsOfServiceId" ], "type": "object" } }, "multipart/form-data": { "schema": { "description": "The request to record consent", "properties": { "email": { "description": "Borrower email (optional)", "example": "email@example.com", "type": "string" }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "phone": { "description": "Borrower phone number (optional)", "example": "6666666666", "type": "string" }, "termsOfServiceId": { "description": "Loan Platform version identifier of Terms of Service", "example": "1.0", "type": "string" } }, "required": [ "id", "termsOfServiceId" ], "type": "object" } }, "text/plain": { "schema": { "description": "The request to record consent", "properties": { "email": { "description": "Borrower email (optional)", "example": "email@example.com", "type": "string" }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "phone": { "description": "Borrower phone number (optional)", "example": "6666666666", "type": "string" }, "termsOfServiceId": { "description": "Loan Platform version identifier of Terms of Service", "example": "1.0", "type": "string" } }, "required": [ "id", "termsOfServiceId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "consent": { "description": "Whether consent was successfully recorded", "example": true, "type": "boolean" }, "consentDateTime": { "description": "Consent timestamp", "example": "2023-12-25T10:30:00", "format": "date", "type": "string" }, "email": { "description": "Borrower email (optional)", "example": "email@example.com", "type": "string" }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "phone": { "description": "Borrower phone number (optional)", "example": "6666666666", "type": "string" }, "termsOfServiceId": { "description": "Loan Platform version identifier of Terms of Service", "example": "1.0", "type": "string" } }, "required": [ "consent", "consentDateTime" ], "type": "object" } }, "multipart/form-data": { "schema": { "properties": { "consent": { "description": "Whether consent was successfully recorded", "example": true, "type": "boolean" }, "consentDateTime": { "description": "Consent timestamp", "example": "2023-12-25T10:30:00", "format": "date", "type": "string" }, "email": { "description": "Borrower email (optional)", "example": "email@example.com", "type": "string" }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "phone": { "description": "Borrower phone number (optional)", "example": "6666666666", "type": "string" }, "termsOfServiceId": { "description": "Loan Platform version identifier of Terms of Service", "example": "1.0", "type": "string" } }, "required": [ "consent", "consentDateTime" ], "type": "object" } }, "text/plain": { "schema": { "properties": { "consent": { "description": "Whether consent was successfully recorded", "example": true, "type": "boolean" }, "consentDateTime": { "description": "Consent timestamp", "example": "2023-12-25T10:30:00", "format": "date", "type": "string" }, "email": { "description": "Borrower email (optional)", "example": "email@example.com", "type": "string" }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "phone": { "description": "Borrower phone number (optional)", "example": "6666666666", "type": "string" }, "termsOfServiceId": { "description": "Loan Platform version identifier of Terms of Service", "example": "1.0", "type": "string" } }, "required": [ "consent", "consentDateTime" ], "type": "object" } } }, "description": "The response to recording consent" } }, "security": [ { "bearerAuth": [] } ], "summary": "Record TCPA Consent", "tags": [ "loans" ] } }, "/v1/loans/schedule-call": { "post": { "description": "Request to schedule a call, regarding a loan application", "operationId": "postV1LoansSchedule-call", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "description": "Request to schedule a call, regarding a loan application", "properties": { "loanId": { "description": "Loan ID to schedule a call for", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "format": "uuid", "type": "string" }, "phoneNumber": { "description": "The phone number to schedule the call for", "example": "1234567890", "type": "string" }, "scheduledAt": { "description": "The date and time to schedule the call for in UTC", "example": "2022-01-01T00:00:00.000Z", "format": "date-time", "type": "string" } }, "required": [ "loanId", "phoneNumber", "scheduledAt" ], "type": "object" } }, "multipart/form-data": { "schema": { "description": "Request to schedule a call, regarding a loan application", "properties": { "loanId": { "description": "Loan ID to schedule a call for", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "format": "uuid", "type": "string" }, "phoneNumber": { "description": "The phone number to schedule the call for", "example": "1234567890", "type": "string" }, "scheduledAt": { "description": "The date and time to schedule the call for in UTC", "example": "2022-01-01T00:00:00.000Z", "format": "date-time", "type": "string" } }, "required": [ "loanId", "phoneNumber", "scheduledAt" ], "type": "object" } }, "text/plain": { "schema": { "description": "Request to schedule a call, regarding a loan application", "properties": { "loanId": { "description": "Loan ID to schedule a call for", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "format": "uuid", "type": "string" }, "phoneNumber": { "description": "The phone number to schedule the call for", "example": "1234567890", "type": "string" }, "scheduledAt": { "description": "The date and time to schedule the call for in UTC", "example": "2022-01-01T00:00:00.000Z", "format": "date-time", "type": "string" } }, "required": [ "loanId", "phoneNumber", "scheduledAt" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "success": { "example": true, "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "multipart/form-data": { "schema": { "properties": { "success": { "example": true, "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "text/plain": { "schema": { "properties": { "success": { "example": true, "type": "boolean" } }, "required": [ "success" ], "type": "object" } } }, "description": "Response for schedule call request" } }, "security": [ { "bearerAuth": [] } ], "summary": "Schedule Call", "tags": [ "loans" ] } }, "/v1/loans/{id}": { "get": { "description": "Get a loan application by ID", "operationId": "getV1LoansById", "parameters": [ { "description": "The unique identifier of the loan application", "in": "path", "name": "id", "required": true, "schema": { "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "borrowers": { "items": { "allOf": [ { "description": "The borrower details", "properties": { "currentAddress": { "description": "The address details", "properties": { "city": { "description": "The city of the address", "example": "San Francisco", "type": "string" }, "county": { "anyOf": [ { "type": "null" }, { "description": "The county of the address", "example": "San Francisco", "type": "string" } ] }, "state": { "description": "The state of the address", "example": "CA", "type": "string" }, "street": { "description": "The street address", "example": "123 Main St", "type": "string" }, "street2": { "anyOf": [ { "type": "null" }, { "description": "The second line of the address", "example": "Apt 123", "type": "string" } ] }, "zip": { "description": "The zip code of the address", "example": "94101", "type": "string" } }, "required": [ "street", "city", "state", "zip" ], "title": "Address", "type": "object" }, "dob": { "description": "The date of birth of the borrower", "example": "1990-01-01", "format": "date", "type": "string" }, "email": { "anyOf": [ { "type": "null" }, { "description": "Required for primary borrower, optional for co-borrowers", "example": "john.doe@example.com", "type": "string" } ] }, "firstName": { "description": "The first name of the borrower", "example": "John", "type": "string" }, "formerAddress": { "anyOf": [ { "type": "null" }, { "description": "The address details", "properties": { "city": { "description": "The city of the address", "example": "San Francisco", "type": "string" }, "county": { "anyOf": [ { "type": "null" }, { "description": "The county of the address", "example": "San Francisco", "type": "string" } ] }, "state": { "description": "The state of the address", "example": "CA", "type": "string" }, "street": { "description": "The street address", "example": "123 Main St", "type": "string" }, "street2": { "anyOf": [ { "type": "null" }, { "description": "The second line of the address", "example": "Apt 123", "type": "string" } ] }, "zip": { "description": "The zip code of the address", "example": "94101", "type": "string" } }, "required": [ "street", "city", "state", "zip" ], "title": "Address", "type": "object" } ] }, "gender": { "description": "The gender of the borrower", "enum": [ "FEMALE", "MALE", "NOT_SPECIFIED" ], "example": "MALE", "type": "string" }, "isPrimary": { "description": "Whether the borrower is the primary borrower", "example": true, "type": "boolean" }, "lastName": { "description": "The last name of the borrower", "example": "Doe", "type": "string" }, "mailingAddress": { "anyOf": [ { "type": "null" }, { "description": "The address details", "properties": { "city": { "description": "The city of the address", "example": "San Francisco", "type": "string" }, "county": { "anyOf": [ { "type": "null" }, { "description": "The county of the address", "example": "San Francisco", "type": "string" } ] }, "state": { "description": "The state of the address", "example": "CA", "type": "string" }, "street": { "description": "The street address", "example": "123 Main St", "type": "string" }, "street2": { "anyOf": [ { "type": "null" }, { "description": "The second line of the address", "example": "Apt 123", "type": "string" } ] }, "zip": { "description": "The zip code of the address", "example": "94101", "type": "string" } }, "required": [ "street", "city", "state", "zip" ], "title": "Address", "type": "object" } ] }, "maritalStatus": { "description": "The marital status of the borrower", "enum": [ "MARRIED", "NOT_PROVIDED", "SEPARATED", "SINGLE", "DIVORCED", "WIDOWED", "DOMESTIC_PARTNER" ], "example": "SINGLE", "type": "string" } }, "required": [ "firstName", "lastName", "isPrimary", "currentAddress" ], "type": "object" }, { "anyOf": [ { "properties": { "email": { "description": "The email address of the primary borrower", "example": "john.doe@example.com", "type": "string" }, "isPrimary": { "const": true, "description": "Whether the borrower is the primary borrower", "examples": [ true ], "type": "boolean" }, "phone": { "description": "The phone number of the primary borrower", "example": "1234567890", "type": "string" } }, "required": [ "isPrimary", "email", "phone" ], "title": "PrimaryBorrower", "type": "object" }, { "properties": { "email": { "anyOf": [ { "type": "null" }, { "description": "The email address of the co-borrower", "example": "jane.doe@example.com", "type": "string" } ] }, "isPrimary": { "const": false, "description": "False for co-borrowers", "examples": [ false ], "type": "boolean" }, "phone": { "anyOf": [ { "type": "null" }, { "description": "The phone number of the co-borrower", "example": "1234567890", "type": "string" } ] } }, "required": [ "isPrimary" ], "title": "CoBorrower", "type": "object" } ] } ] }, "type": "array" }, "closingDate": { "anyOf": [ { "type": "null" }, { "description": "The closing date of the loan (ISO string)", "example": "2025-01-01T00:00:00.000Z", "format": "date", "type": "string" } ] }, "contactPageUrl": { "anyOf": [ { "type": "null" }, { "description": "URL for the contact page for this loan application", "example": "https://getquote.itscovered.com/contact/0f1a6ab7-2b4b-4d4d-aa9b-47086e80794d", "format": "uri", "type": "string" } ] }, "currentInsurancePolicies": { "items": { "properties": { "carrier": { "anyOf": [ { "description": "The name of the current insurance carrier", "type": "string" }, { "type": "null" } ] }, "coverages": { "properties": { "a": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "b": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "c": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "computers": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "d": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "e": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "f": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "hvac": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "mineSubsidence": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "waterBackup": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" } }, "type": "object" }, "deductible": { "anyOf": [ { "description": "The deductible of the current insurance policy", "type": "number" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "description": "The expiration date of the current insurance policy", "type": "string" }, { "type": "null" } ] }, "policyNumber": { "anyOf": [ { "description": "The policy number of the current insurance policy", "type": "string" }, { "type": "null" } ] }, "policyType": { "anyOf": [ { "description": "The type of policy", "enum": [ "HO3", "HO5", "HO6" ], "example": "HO3" }, { "type": "null" } ] }, "premium": { "anyOf": [ { "description": "The annual premium of the current insurance policy", "type": "number" }, { "type": "null" } ] } }, "type": "object" }, "type": "array" }, "externalId": { "description": "An external identifier passed in when the loan application was created. Defaults to loanNumber", "example": "1234567890", "type": "string" }, "hostedDisplayUrl": { "default": "", "description": "The URL to display the loan application shop", "example": "https://getquote.itscovered.com/acmemortgage/v2/quote/home/693f2f46-69ff-4f20-a4d9-abe982d34fd4", "format": "uri", "type": "string" }, "id": { "description": "Loan application ID", "example": "0f1a6ab7-2b4b-4d4d-aa9b-47086e80794d", "type": "string" }, "loanAmount": { "anyOf": [ { "type": "null" }, { "description": "The loan amount", "example": 100000, "type": "number" } ] }, "loanNumber": { "description": "The loan number", "example": "1234567890", "type": "string" }, "loanOfficer": { "anyOf": [ { "type": "null" }, { "description": "The loan contact information", "properties": { "email": { "description": "The email of the loan officer", "example": "john.doe@example.com", "type": "string" }, "firstName": { "description": "The first name of the loan officer", "example": "John", "type": "string" }, "lastName": { "description": "The last name of the loan officer", "example": "Doe", "type": "string" }, "phone": { "description": "The phone number of the loan officer", "example": "1234567890", "type": "string" } }, "required": [ "firstName", "lastName", "email", "phone" ], "type": "object" } ] }, "loanPurpose": { "anyOf": [ { "type": "null" }, { "description": "The purpose of the loan", "enum": [ "PURCHASE", "REFINANCE", "CONSTRUCTION", "CONSTRUCTION PERM", "MORTGAGE MODIFICATION", "LAND_LOT", "OTHER" ], "example": "PURCHASE", "type": "string" } ] }, "loanType": { "anyOf": [ { "type": "null" }, { "description": "The type of the loan", "enum": [ "MORTGAGE", "HELOC", "HELOAN", "UNKNOWN_LOAN_TYPE" ], "example": "MORTGAGE", "type": "string" } ] }, "property": { "description": "The property details", "properties": { "address": { "description": "The address details", "properties": { "city": { "description": "The city of the address", "example": "San Francisco", "type": "string" }, "county": { "anyOf": [ { "type": "null" }, { "description": "The county of the address", "example": "San Francisco", "type": "string" } ] }, "state": { "description": "The state of the address", "example": "CA", "type": "string" }, "street": { "description": "The street address", "example": "123 Main St", "type": "string" }, "street2": { "anyOf": [ { "type": "null" }, { "description": "The second line of the address", "example": "Apt 123", "type": "string" } ] }, "zip": { "description": "The zip code of the address", "example": "94101", "type": "string" } }, "required": [ "street", "city", "state", "zip" ], "title": "Address", "type": "object" } }, "required": [ "address" ], "title": "Property", "type": "object" }, "shortHostedDisplayUrl": { "anyOf": [ { "type": "null" }, { "description": "Short URL for the hosted borrower quote experience, when available", "example": "https://cvd.io/abc123", "format": "uri", "type": "string" } ] }, "status": { "description": "The status of the loan application shop", "enum": [ "NOT_YET_RATED", "RC1_RATING", "RC1_RATED", "RC2_RATING", "RC2_RATED", "RC1_ERRORED", "CLOSED_WON", "CLOSED_LOST" ], "example": "RC1_RATING", "type": "string" } }, "required": [ "loanNumber", "borrowers", "id", "property", "status", "hostedDisplayUrl", "currentInsurancePolicies" ], "type": "object" } }, "multipart/form-data": { "schema": { "properties": { "borrowers": { "items": { "allOf": [ { "description": "The borrower details", "properties": { "currentAddress": { "description": "The address details", "properties": { "city": { "description": "The city of the address", "example": "San Francisco", "type": "string" }, "county": { "anyOf": [ { "type": "null" }, { "description": "The county of the address", "example": "San Francisco", "type": "string" } ] }, "state": { "description": "The state of the address", "example": "CA", "type": "string" }, "street": { "description": "The street address", "example": "123 Main St", "type": "string" }, "street2": { "anyOf": [ { "type": "null" }, { "description": "The second line of the address", "example": "Apt 123", "type": "string" } ] }, "zip": { "description": "The zip code of the address", "example": "94101", "type": "string" } }, "required": [ "street", "city", "state", "zip" ], "title": "Address", "type": "object" }, "dob": { "description": "The date of birth of the borrower", "example": "1990-01-01", "format": "date", "type": "string" }, "email": { "anyOf": [ { "type": "null" }, { "description": "Required for primary borrower, optional for co-borrowers", "example": "john.doe@example.com", "type": "string" } ] }, "firstName": { "description": "The first name of the borrower", "example": "John", "type": "string" }, "formerAddress": { "anyOf": [ { "type": "null" }, { "description": "The address details", "properties": { "city": { "description": "The city of the address", "example": "San Francisco", "type": "string" }, "county": { "anyOf": [ { "type": "null" }, { "description": "The county of the address", "example": "San Francisco", "type": "string" } ] }, "state": { "description": "The state of the address", "example": "CA", "type": "string" }, "street": { "description": "The street address", "example": "123 Main St", "type": "string" }, "street2": { "anyOf": [ { "type": "null" }, { "description": "The second line of the address", "example": "Apt 123", "type": "string" } ] }, "zip": { "description": "The zip code of the address", "example": "94101", "type": "string" } }, "required": [ "street", "city", "state", "zip" ], "title": "Address", "type": "object" } ] }, "gender": { "description": "The gender of the borrower", "enum": [ "FEMALE", "MALE", "NOT_SPECIFIED" ], "example": "MALE", "type": "string" }, "isPrimary": { "description": "Whether the borrower is the primary borrower", "example": true, "type": "boolean" }, "lastName": { "description": "The last name of the borrower", "example": "Doe", "type": "string" }, "mailingAddress": { "anyOf": [ { "type": "null" }, { "description": "The address details", "properties": { "city": { "description": "The city of the address", "example": "San Francisco", "type": "string" }, "county": { "anyOf": [ { "type": "null" }, { "description": "The county of the address", "example": "San Francisco", "type": "string" } ] }, "state": { "description": "The state of the address", "example": "CA", "type": "string" }, "street": { "description": "The street address", "example": "123 Main St", "type": "string" }, "street2": { "anyOf": [ { "type": "null" }, { "description": "The second line of the address", "example": "Apt 123", "type": "string" } ] }, "zip": { "description": "The zip code of the address", "example": "94101", "type": "string" } }, "required": [ "street", "city", "state", "zip" ], "title": "Address", "type": "object" } ] }, "maritalStatus": { "description": "The marital status of the borrower", "enum": [ "MARRIED", "NOT_PROVIDED", "SEPARATED", "SINGLE", "DIVORCED", "WIDOWED", "DOMESTIC_PARTNER" ], "example": "SINGLE", "type": "string" } }, "required": [ "firstName", "lastName", "isPrimary", "currentAddress" ], "type": "object" }, { "anyOf": [ { "properties": { "email": { "description": "The email address of the primary borrower", "example": "john.doe@example.com", "type": "string" }, "isPrimary": { "const": true, "description": "Whether the borrower is the primary borrower", "examples": [ true ], "type": "boolean" }, "phone": { "description": "The phone number of the primary borrower", "example": "1234567890", "type": "string" } }, "required": [ "isPrimary", "email", "phone" ], "title": "PrimaryBorrower", "type": "object" }, { "properties": { "email": { "anyOf": [ { "type": "null" }, { "description": "The email address of the co-borrower", "example": "jane.doe@example.com", "type": "string" } ] }, "isPrimary": { "const": false, "description": "False for co-borrowers", "examples": [ false ], "type": "boolean" }, "phone": { "anyOf": [ { "type": "null" }, { "description": "The phone number of the co-borrower", "example": "1234567890", "type": "string" } ] } }, "required": [ "isPrimary" ], "title": "CoBorrower", "type": "object" } ] } ] }, "type": "array" }, "closingDate": { "anyOf": [ { "type": "null" }, { "description": "The closing date of the loan (ISO string)", "example": "2025-01-01T00:00:00.000Z", "format": "date", "type": "string" } ] }, "contactPageUrl": { "anyOf": [ { "type": "null" }, { "description": "URL for the contact page for this loan application", "example": "https://getquote.itscovered.com/contact/0f1a6ab7-2b4b-4d4d-aa9b-47086e80794d", "format": "uri", "type": "string" } ] }, "currentInsurancePolicies": { "items": { "properties": { "carrier": { "anyOf": [ { "description": "The name of the current insurance carrier", "type": "string" }, { "type": "null" } ] }, "coverages": { "properties": { "a": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "b": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "c": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "computers": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "d": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "e": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "f": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "hvac": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "mineSubsidence": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "waterBackup": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" } }, "type": "object" }, "deductible": { "anyOf": [ { "description": "The deductible of the current insurance policy", "type": "number" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "description": "The expiration date of the current insurance policy", "type": "string" }, { "type": "null" } ] }, "policyNumber": { "anyOf": [ { "description": "The policy number of the current insurance policy", "type": "string" }, { "type": "null" } ] }, "policyType": { "anyOf": [ { "description": "The type of policy", "enum": [ "HO3", "HO5", "HO6" ], "example": "HO3" }, { "type": "null" } ] }, "premium": { "anyOf": [ { "description": "The annual premium of the current insurance policy", "type": "number" }, { "type": "null" } ] } }, "type": "object" }, "type": "array" }, "externalId": { "description": "An external identifier passed in when the loan application was created. Defaults to loanNumber", "example": "1234567890", "type": "string" }, "hostedDisplayUrl": { "default": "", "description": "The URL to display the loan application shop", "example": "https://getquote.itscovered.com/acmemortgage/v2/quote/home/693f2f46-69ff-4f20-a4d9-abe982d34fd4", "format": "uri", "type": "string" }, "id": { "description": "Loan application ID", "example": "0f1a6ab7-2b4b-4d4d-aa9b-47086e80794d", "type": "string" }, "loanAmount": { "anyOf": [ { "type": "null" }, { "description": "The loan amount", "example": 100000, "type": "number" } ] }, "loanNumber": { "description": "The loan number", "example": "1234567890", "type": "string" }, "loanOfficer": { "anyOf": [ { "type": "null" }, { "description": "The loan contact information", "properties": { "email": { "description": "The email of the loan officer", "example": "john.doe@example.com", "type": "string" }, "firstName": { "description": "The first name of the loan officer", "example": "John", "type": "string" }, "lastName": { "description": "The last name of the loan officer", "example": "Doe", "type": "string" }, "phone": { "description": "The phone number of the loan officer", "example": "1234567890", "type": "string" } }, "required": [ "firstName", "lastName", "email", "phone" ], "type": "object" } ] }, "loanPurpose": { "anyOf": [ { "type": "null" }, { "description": "The purpose of the loan", "enum": [ "PURCHASE", "REFINANCE", "CONSTRUCTION", "CONSTRUCTION PERM", "MORTGAGE MODIFICATION", "LAND_LOT", "OTHER" ], "example": "PURCHASE", "type": "string" } ] }, "loanType": { "anyOf": [ { "type": "null" }, { "description": "The type of the loan", "enum": [ "MORTGAGE", "HELOC", "HELOAN", "UNKNOWN_LOAN_TYPE" ], "example": "MORTGAGE", "type": "string" } ] }, "property": { "description": "The property details", "properties": { "address": { "description": "The address details", "properties": { "city": { "description": "The city of the address", "example": "San Francisco", "type": "string" }, "county": { "anyOf": [ { "type": "null" }, { "description": "The county of the address", "example": "San Francisco", "type": "string" } ] }, "state": { "description": "The state of the address", "example": "CA", "type": "string" }, "street": { "description": "The street address", "example": "123 Main St", "type": "string" }, "street2": { "anyOf": [ { "type": "null" }, { "description": "The second line of the address", "example": "Apt 123", "type": "string" } ] }, "zip": { "description": "The zip code of the address", "example": "94101", "type": "string" } }, "required": [ "street", "city", "state", "zip" ], "title": "Address", "type": "object" } }, "required": [ "address" ], "title": "Property", "type": "object" }, "shortHostedDisplayUrl": { "anyOf": [ { "type": "null" }, { "description": "Short URL for the hosted borrower quote experience, when available", "example": "https://cvd.io/abc123", "format": "uri", "type": "string" } ] }, "status": { "description": "The status of the loan application shop", "enum": [ "NOT_YET_RATED", "RC1_RATING", "RC1_RATED", "RC2_RATING", "RC2_RATED", "RC1_ERRORED", "CLOSED_WON", "CLOSED_LOST" ], "example": "RC1_RATING", "type": "string" } }, "required": [ "loanNumber", "borrowers", "id", "property", "status", "hostedDisplayUrl", "currentInsurancePolicies" ], "type": "object" } }, "text/plain": { "schema": { "properties": { "borrowers": { "items": { "allOf": [ { "description": "The borrower details", "properties": { "currentAddress": { "description": "The address details", "properties": { "city": { "description": "The city of the address", "example": "San Francisco", "type": "string" }, "county": { "anyOf": [ { "type": "null" }, { "description": "The county of the address", "example": "San Francisco", "type": "string" } ] }, "state": { "description": "The state of the address", "example": "CA", "type": "string" }, "street": { "description": "The street address", "example": "123 Main St", "type": "string" }, "street2": { "anyOf": [ { "type": "null" }, { "description": "The second line of the address", "example": "Apt 123", "type": "string" } ] }, "zip": { "description": "The zip code of the address", "example": "94101", "type": "string" } }, "required": [ "street", "city", "state", "zip" ], "title": "Address", "type": "object" }, "dob": { "description": "The date of birth of the borrower", "example": "1990-01-01", "format": "date", "type": "string" }, "email": { "anyOf": [ { "type": "null" }, { "description": "Required for primary borrower, optional for co-borrowers", "example": "john.doe@example.com", "type": "string" } ] }, "firstName": { "description": "The first name of the borrower", "example": "John", "type": "string" }, "formerAddress": { "anyOf": [ { "type": "null" }, { "description": "The address details", "properties": { "city": { "description": "The city of the address", "example": "San Francisco", "type": "string" }, "county": { "anyOf": [ { "type": "null" }, { "description": "The county of the address", "example": "San Francisco", "type": "string" } ] }, "state": { "description": "The state of the address", "example": "CA", "type": "string" }, "street": { "description": "The street address", "example": "123 Main St", "type": "string" }, "street2": { "anyOf": [ { "type": "null" }, { "description": "The second line of the address", "example": "Apt 123", "type": "string" } ] }, "zip": { "description": "The zip code of the address", "example": "94101", "type": "string" } }, "required": [ "street", "city", "state", "zip" ], "title": "Address", "type": "object" } ] }, "gender": { "description": "The gender of the borrower", "enum": [ "FEMALE", "MALE", "NOT_SPECIFIED" ], "example": "MALE", "type": "string" }, "isPrimary": { "description": "Whether the borrower is the primary borrower", "example": true, "type": "boolean" }, "lastName": { "description": "The last name of the borrower", "example": "Doe", "type": "string" }, "mailingAddress": { "anyOf": [ { "type": "null" }, { "description": "The address details", "properties": { "city": { "description": "The city of the address", "example": "San Francisco", "type": "string" }, "county": { "anyOf": [ { "type": "null" }, { "description": "The county of the address", "example": "San Francisco", "type": "string" } ] }, "state": { "description": "The state of the address", "example": "CA", "type": "string" }, "street": { "description": "The street address", "example": "123 Main St", "type": "string" }, "street2": { "anyOf": [ { "type": "null" }, { "description": "The second line of the address", "example": "Apt 123", "type": "string" } ] }, "zip": { "description": "The zip code of the address", "example": "94101", "type": "string" } }, "required": [ "street", "city", "state", "zip" ], "title": "Address", "type": "object" } ] }, "maritalStatus": { "description": "The marital status of the borrower", "enum": [ "MARRIED", "NOT_PROVIDED", "SEPARATED", "SINGLE", "DIVORCED", "WIDOWED", "DOMESTIC_PARTNER" ], "example": "SINGLE", "type": "string" } }, "required": [ "firstName", "lastName", "isPrimary", "currentAddress" ], "type": "object" }, { "anyOf": [ { "properties": { "email": { "description": "The email address of the primary borrower", "example": "john.doe@example.com", "type": "string" }, "isPrimary": { "const": true, "description": "Whether the borrower is the primary borrower", "examples": [ true ], "type": "boolean" }, "phone": { "description": "The phone number of the primary borrower", "example": "1234567890", "type": "string" } }, "required": [ "isPrimary", "email", "phone" ], "title": "PrimaryBorrower", "type": "object" }, { "properties": { "email": { "anyOf": [ { "type": "null" }, { "description": "The email address of the co-borrower", "example": "jane.doe@example.com", "type": "string" } ] }, "isPrimary": { "const": false, "description": "False for co-borrowers", "examples": [ false ], "type": "boolean" }, "phone": { "anyOf": [ { "type": "null" }, { "description": "The phone number of the co-borrower", "example": "1234567890", "type": "string" } ] } }, "required": [ "isPrimary" ], "title": "CoBorrower", "type": "object" } ] } ] }, "type": "array" }, "closingDate": { "anyOf": [ { "type": "null" }, { "description": "The closing date of the loan (ISO string)", "example": "2025-01-01T00:00:00.000Z", "format": "date", "type": "string" } ] }, "contactPageUrl": { "anyOf": [ { "type": "null" }, { "description": "URL for the contact page for this loan application", "example": "https://getquote.itscovered.com/contact/0f1a6ab7-2b4b-4d4d-aa9b-47086e80794d", "format": "uri", "type": "string" } ] }, "currentInsurancePolicies": { "items": { "properties": { "carrier": { "anyOf": [ { "description": "The name of the current insurance carrier", "type": "string" }, { "type": "null" } ] }, "coverages": { "properties": { "a": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "b": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "c": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "computers": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "d": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "e": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "f": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "hvac": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "mineSubsidence": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "waterBackup": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" } }, "type": "object" }, "deductible": { "anyOf": [ { "description": "The deductible of the current insurance policy", "type": "number" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "description": "The expiration date of the current insurance policy", "type": "string" }, { "type": "null" } ] }, "policyNumber": { "anyOf": [ { "description": "The policy number of the current insurance policy", "type": "string" }, { "type": "null" } ] }, "policyType": { "anyOf": [ { "description": "The type of policy", "enum": [ "HO3", "HO5", "HO6" ], "example": "HO3" }, { "type": "null" } ] }, "premium": { "anyOf": [ { "description": "The annual premium of the current insurance policy", "type": "number" }, { "type": "null" } ] } }, "type": "object" }, "type": "array" }, "externalId": { "description": "An external identifier passed in when the loan application was created. Defaults to loanNumber", "example": "1234567890", "type": "string" }, "hostedDisplayUrl": { "default": "", "description": "The URL to display the loan application shop", "example": "https://getquote.itscovered.com/acmemortgage/v2/quote/home/693f2f46-69ff-4f20-a4d9-abe982d34fd4", "format": "uri", "type": "string" }, "id": { "description": "Loan application ID", "example": "0f1a6ab7-2b4b-4d4d-aa9b-47086e80794d", "type": "string" }, "loanAmount": { "anyOf": [ { "type": "null" }, { "description": "The loan amount", "example": 100000, "type": "number" } ] }, "loanNumber": { "description": "The loan number", "example": "1234567890", "type": "string" }, "loanOfficer": { "anyOf": [ { "type": "null" }, { "description": "The loan contact information", "properties": { "email": { "description": "The email of the loan officer", "example": "john.doe@example.com", "type": "string" }, "firstName": { "description": "The first name of the loan officer", "example": "John", "type": "string" }, "lastName": { "description": "The last name of the loan officer", "example": "Doe", "type": "string" }, "phone": { "description": "The phone number of the loan officer", "example": "1234567890", "type": "string" } }, "required": [ "firstName", "lastName", "email", "phone" ], "type": "object" } ] }, "loanPurpose": { "anyOf": [ { "type": "null" }, { "description": "The purpose of the loan", "enum": [ "PURCHASE", "REFINANCE", "CONSTRUCTION", "CONSTRUCTION PERM", "MORTGAGE MODIFICATION", "LAND_LOT", "OTHER" ], "example": "PURCHASE", "type": "string" } ] }, "loanType": { "anyOf": [ { "type": "null" }, { "description": "The type of the loan", "enum": [ "MORTGAGE", "HELOC", "HELOAN", "UNKNOWN_LOAN_TYPE" ], "example": "MORTGAGE", "type": "string" } ] }, "property": { "description": "The property details", "properties": { "address": { "description": "The address details", "properties": { "city": { "description": "The city of the address", "example": "San Francisco", "type": "string" }, "county": { "anyOf": [ { "type": "null" }, { "description": "The county of the address", "example": "San Francisco", "type": "string" } ] }, "state": { "description": "The state of the address", "example": "CA", "type": "string" }, "street": { "description": "The street address", "example": "123 Main St", "type": "string" }, "street2": { "anyOf": [ { "type": "null" }, { "description": "The second line of the address", "example": "Apt 123", "type": "string" } ] }, "zip": { "description": "The zip code of the address", "example": "94101", "type": "string" } }, "required": [ "street", "city", "state", "zip" ], "title": "Address", "type": "object" } }, "required": [ "address" ], "title": "Property", "type": "object" }, "shortHostedDisplayUrl": { "anyOf": [ { "type": "null" }, { "description": "Short URL for the hosted borrower quote experience, when available", "example": "https://cvd.io/abc123", "format": "uri", "type": "string" } ] }, "status": { "description": "The status of the loan application shop", "enum": [ "NOT_YET_RATED", "RC1_RATING", "RC1_RATED", "RC2_RATING", "RC2_RATED", "RC1_ERRORED", "CLOSED_WON", "CLOSED_LOST" ], "example": "RC1_RATING", "type": "string" } }, "required": [ "loanNumber", "borrowers", "id", "property", "status", "hostedDisplayUrl", "currentInsurancePolicies" ], "type": "object" } } }, "description": "The response to getting a loan application" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get Loan Application", "tags": [ "loans" ] } }, "/v1/loans/{id}/close": { "patch": { "description": "Close a loan application, and optionally provide external insurance details", "operationId": "patchV1LoansByIdClose", "parameters": [ { "description": "The unique identifier of the loan application", "in": "path", "name": "id", "required": true, "schema": { "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "externalInsurance": { "description": "External insurance details, when customer specified that they had obtained insurance elsewhere (if applicable)", "properties": { "carrier": { "description": "Name of the insurance carrier", "example": "Example Insurance Co.", "minLength": 1, "type": "string" }, "coverageA": { "description": "Coverage A amount in USD", "example": 250000, "minimum": 0, "type": "number" }, "premium": { "description": "Annual premium amount in USD", "example": 1200, "minimum": 0, "type": "number" } }, "title": "External Insurance Details", "type": "object" } }, "type": "object" } }, "multipart/form-data": { "schema": { "properties": { "externalInsurance": { "description": "External insurance details, when customer specified that they had obtained insurance elsewhere (if applicable)", "properties": { "carrier": { "description": "Name of the insurance carrier", "example": "Example Insurance Co.", "minLength": 1, "type": "string" }, "coverageA": { "description": "Coverage A amount in USD", "example": 250000, "minimum": 0, "type": "number" }, "premium": { "description": "Annual premium amount in USD", "example": 1200, "minimum": 0, "type": "number" } }, "title": "External Insurance Details", "type": "object" } }, "type": "object" } }, "text/plain": { "schema": { "properties": { "externalInsurance": { "description": "External insurance details, when customer specified that they had obtained insurance elsewhere (if applicable)", "properties": { "carrier": { "description": "Name of the insurance carrier", "example": "Example Insurance Co.", "minLength": 1, "type": "string" }, "coverageA": { "description": "Coverage A amount in USD", "example": 250000, "minimum": 0, "type": "number" }, "premium": { "description": "Annual premium amount in USD", "example": 1200, "minimum": 0, "type": "number" } }, "title": "External Insurance Details", "type": "object" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "success": { "example": true, "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "multipart/form-data": { "schema": { "properties": { "success": { "example": true, "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "text/plain": { "schema": { "properties": { "success": { "example": true, "type": "boolean" } }, "required": [ "success" ], "type": "object" } } }, "description": "Indicates that the loan application was closed successfully" }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "example": "Failed to close loan application", "type": "string" } }, "required": [ "error" ], "type": "object" } }, "multipart/form-data": { "schema": { "properties": { "error": { "example": "Failed to close loan application", "type": "string" } }, "required": [ "error" ], "type": "object" } }, "text/plain": { "schema": { "properties": { "error": { "example": "Failed to close loan application", "type": "string" } }, "required": [ "error" ], "type": "object" } } }, "description": "Error response when closing loan application" } }, "security": [ { "bearerAuth": [] } ], "summary": "Close Loan Application", "tags": [ "loans" ] } }, "/v1/loans/{id}/current-insurance": { "put": { "description": "Add current insurance policies to a loan application", "operationId": "putV1LoansByIdCurrent-insurance", "parameters": [ { "description": "The unique identifier of the loan application", "in": "path", "name": "id", "required": true, "schema": { "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "currentInsurancePolicies": { "items": { "properties": { "carrier": { "anyOf": [ { "description": "The name of the current insurance carrier", "type": "string" }, { "type": "null" } ] }, "coverages": { "properties": { "a": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "b": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "c": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "computers": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "d": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "e": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "f": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "hvac": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "mineSubsidence": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "waterBackup": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" } }, "type": "object" }, "deductible": { "anyOf": [ { "description": "The deductible of the current insurance policy", "type": "number" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "description": "The expiration date of the current insurance policy", "type": "string" }, { "type": "null" } ] }, "policyNumber": { "anyOf": [ { "description": "The policy number of the current insurance policy", "type": "string" }, { "type": "null" } ] }, "policyType": { "anyOf": [ { "description": "The type of policy", "enum": [ "HO3", "HO5", "HO6" ], "example": "HO3" }, { "type": "null" } ] }, "premium": { "anyOf": [ { "description": "The annual premium of the current insurance policy", "type": "number" }, { "type": "null" } ] } }, "type": "object" }, "type": "array" } }, "required": [ "currentInsurancePolicies" ], "type": "object" } }, "multipart/form-data": { "schema": { "properties": { "currentInsurancePolicies": { "items": { "properties": { "carrier": { "anyOf": [ { "description": "The name of the current insurance carrier", "type": "string" }, { "type": "null" } ] }, "coverages": { "properties": { "a": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "b": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "c": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "computers": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "d": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "e": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "f": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "hvac": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "mineSubsidence": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "waterBackup": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" } }, "type": "object" }, "deductible": { "anyOf": [ { "description": "The deductible of the current insurance policy", "type": "number" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "description": "The expiration date of the current insurance policy", "type": "string" }, { "type": "null" } ] }, "policyNumber": { "anyOf": [ { "description": "The policy number of the current insurance policy", "type": "string" }, { "type": "null" } ] }, "policyType": { "anyOf": [ { "description": "The type of policy", "enum": [ "HO3", "HO5", "HO6" ], "example": "HO3" }, { "type": "null" } ] }, "premium": { "anyOf": [ { "description": "The annual premium of the current insurance policy", "type": "number" }, { "type": "null" } ] } }, "type": "object" }, "type": "array" } }, "required": [ "currentInsurancePolicies" ], "type": "object" } }, "text/plain": { "schema": { "properties": { "currentInsurancePolicies": { "items": { "properties": { "carrier": { "anyOf": [ { "description": "The name of the current insurance carrier", "type": "string" }, { "type": "null" } ] }, "coverages": { "properties": { "a": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "b": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "c": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "computers": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "d": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "e": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "f": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "hvac": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "mineSubsidence": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "waterBackup": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" } }, "type": "object" }, "deductible": { "anyOf": [ { "description": "The deductible of the current insurance policy", "type": "number" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "description": "The expiration date of the current insurance policy", "type": "string" }, { "type": "null" } ] }, "policyNumber": { "anyOf": [ { "description": "The policy number of the current insurance policy", "type": "string" }, { "type": "null" } ] }, "policyType": { "anyOf": [ { "description": "The type of policy", "enum": [ "HO3", "HO5", "HO6" ], "example": "HO3" }, { "type": "null" } ] }, "premium": { "anyOf": [ { "description": "The annual premium of the current insurance policy", "type": "number" }, { "type": "null" } ] } }, "type": "object" }, "type": "array" } }, "required": [ "currentInsurancePolicies" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "currentInsurancePolicies": { "items": { "properties": { "carrier": { "anyOf": [ { "description": "The name of the current insurance carrier", "type": "string" }, { "type": "null" } ] }, "coverages": { "properties": { "a": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "b": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "c": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "computers": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "d": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "e": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "f": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "hvac": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "mineSubsidence": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "waterBackup": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" } }, "type": "object" }, "deductible": { "anyOf": [ { "description": "The deductible of the current insurance policy", "type": "number" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "description": "The expiration date of the current insurance policy", "type": "string" }, { "type": "null" } ] }, "policyNumber": { "anyOf": [ { "description": "The policy number of the current insurance policy", "type": "string" }, { "type": "null" } ] }, "policyType": { "anyOf": [ { "description": "The type of policy", "enum": [ "HO3", "HO5", "HO6" ], "example": "HO3" }, { "type": "null" } ] }, "premium": { "anyOf": [ { "description": "The annual premium of the current insurance policy", "type": "number" }, { "type": "null" } ] } }, "type": "object" }, "type": "array" }, "id": { "type": "string" } }, "required": [ "id", "currentInsurancePolicies" ], "type": "object" } }, "multipart/form-data": { "schema": { "properties": { "currentInsurancePolicies": { "items": { "properties": { "carrier": { "anyOf": [ { "description": "The name of the current insurance carrier", "type": "string" }, { "type": "null" } ] }, "coverages": { "properties": { "a": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "b": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "c": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "computers": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "d": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "e": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "f": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "hvac": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "mineSubsidence": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "waterBackup": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" } }, "type": "object" }, "deductible": { "anyOf": [ { "description": "The deductible of the current insurance policy", "type": "number" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "description": "The expiration date of the current insurance policy", "type": "string" }, { "type": "null" } ] }, "policyNumber": { "anyOf": [ { "description": "The policy number of the current insurance policy", "type": "string" }, { "type": "null" } ] }, "policyType": { "anyOf": [ { "description": "The type of policy", "enum": [ "HO3", "HO5", "HO6" ], "example": "HO3" }, { "type": "null" } ] }, "premium": { "anyOf": [ { "description": "The annual premium of the current insurance policy", "type": "number" }, { "type": "null" } ] } }, "type": "object" }, "type": "array" }, "id": { "type": "string" } }, "required": [ "id", "currentInsurancePolicies" ], "type": "object" } }, "text/plain": { "schema": { "properties": { "currentInsurancePolicies": { "items": { "properties": { "carrier": { "anyOf": [ { "description": "The name of the current insurance carrier", "type": "string" }, { "type": "null" } ] }, "coverages": { "properties": { "a": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "b": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "c": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "computers": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "d": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "e": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "f": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "hvac": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "mineSubsidence": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "waterBackup": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" } }, "type": "object" }, "deductible": { "anyOf": [ { "description": "The deductible of the current insurance policy", "type": "number" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "description": "The expiration date of the current insurance policy", "type": "string" }, { "type": "null" } ] }, "policyNumber": { "anyOf": [ { "description": "The policy number of the current insurance policy", "type": "string" }, { "type": "null" } ] }, "policyType": { "anyOf": [ { "description": "The type of policy", "enum": [ "HO3", "HO5", "HO6" ], "example": "HO3" }, { "type": "null" } ] }, "premium": { "anyOf": [ { "description": "The annual premium of the current insurance policy", "type": "number" }, { "type": "null" } ] } }, "type": "object" }, "type": "array" }, "id": { "type": "string" } }, "required": [ "id", "currentInsurancePolicies" ], "type": "object" } } }, "description": "The response to adding current insurance policies to a loan application" } }, "security": [ { "bearerAuth": [] } ], "summary": "Add Current Insurance Policies", "tags": [ "loans" ] } }, "/v1/loans/{id}/loan-contacts": { "delete": { "operationId": "deleteV1LoansByIdLoan-contacts", "parameters": [ { "description": "The unique identifier of the loan application", "in": "path", "name": "id", "required": true, "schema": { "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearerAuth": [] } ], "tags": [ "loans" ] }, "put": { "description": "Add or update the loan contacts for a loan application", "operationId": "putV1LoansByIdLoan-contacts", "parameters": [ { "description": "The unique identifier of the loan application", "in": "path", "name": "id", "required": true, "schema": { "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "The set of loan contacts", "items": { "description": "The loan contact information", "properties": { "email": { "description": "The email of the loan officer", "example": "john.doe@example.com", "type": "string" }, "firstName": { "description": "The first name of the loan officer", "example": "John", "type": "string" }, "lastName": { "description": "The last name of the loan officer", "example": "Doe", "type": "string" }, "phone": { "description": "The phone number of the loan officer", "example": "1234567890", "type": "string" }, "role": { "description": "The role of the loan contact", "example": "Loan Officer", "type": "string" } }, "required": [ "firstName", "lastName", "email", "phone", "role" ], "type": "object" }, "type": "array" } }, "multipart/form-data": { "schema": { "description": "The set of loan contacts", "items": { "description": "The loan contact information", "properties": { "email": { "description": "The email of the loan officer", "example": "john.doe@example.com", "type": "string" }, "firstName": { "description": "The first name of the loan officer", "example": "John", "type": "string" }, "lastName": { "description": "The last name of the loan officer", "example": "Doe", "type": "string" }, "phone": { "description": "The phone number of the loan officer", "example": "1234567890", "type": "string" }, "role": { "description": "The role of the loan contact", "example": "Loan Officer", "type": "string" } }, "required": [ "firstName", "lastName", "email", "phone", "role" ], "type": "object" }, "type": "array" } }, "text/plain": { "schema": { "description": "The set of loan contacts", "items": { "description": "The loan contact information", "properties": { "email": { "description": "The email of the loan officer", "example": "john.doe@example.com", "type": "string" }, "firstName": { "description": "The first name of the loan officer", "example": "John", "type": "string" }, "lastName": { "description": "The last name of the loan officer", "example": "Doe", "type": "string" }, "phone": { "description": "The phone number of the loan officer", "example": "1234567890", "type": "string" }, "role": { "description": "The role of the loan contact", "example": "Loan Officer", "type": "string" } }, "required": [ "firstName", "lastName", "email", "phone", "role" ], "type": "object" }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "No Content" } }, "security": [ { "bearerAuth": [] } ], "summary": "Add or Update Loan Contacts", "tags": [ "loans" ] } }, "/v1/loans/{id}/loan-officer": { "delete": { "description": "Remove the loan officer for a loan application", "operationId": "deleteV1LoansByIdLoan-officer", "parameters": [ { "description": "The unique identifier of the loan application", "in": "path", "name": "id", "required": true, "schema": { "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearerAuth": [] } ], "summary": "Remove Loan Officer", "tags": [ "loans" ] }, "put": { "description": "Add or update the loan officer for a loan application", "operationId": "putV1LoansByIdLoan-officer", "parameters": [ { "description": "The unique identifier of the loan application", "in": "path", "name": "id", "required": true, "schema": { "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "The loan contact information", "properties": { "email": { "description": "The email of the loan officer", "example": "john.doe@example.com", "type": "string" }, "firstName": { "description": "The first name of the loan officer", "example": "John", "type": "string" }, "lastName": { "description": "The last name of the loan officer", "example": "Doe", "type": "string" }, "phone": { "description": "The phone number of the loan officer", "example": "1234567890", "type": "string" } }, "required": [ "firstName", "lastName", "email", "phone" ], "type": "object" } }, "multipart/form-data": { "schema": { "description": "The loan contact information", "properties": { "email": { "description": "The email of the loan officer", "example": "john.doe@example.com", "type": "string" }, "firstName": { "description": "The first name of the loan officer", "example": "John", "type": "string" }, "lastName": { "description": "The last name of the loan officer", "example": "Doe", "type": "string" }, "phone": { "description": "The phone number of the loan officer", "example": "1234567890", "type": "string" } }, "required": [ "firstName", "lastName", "email", "phone" ], "type": "object" } }, "text/plain": { "schema": { "description": "The loan contact information", "properties": { "email": { "description": "The email of the loan officer", "example": "john.doe@example.com", "type": "string" }, "firstName": { "description": "The first name of the loan officer", "example": "John", "type": "string" }, "lastName": { "description": "The last name of the loan officer", "example": "Doe", "type": "string" }, "phone": { "description": "The phone number of the loan officer", "example": "1234567890", "type": "string" } }, "required": [ "firstName", "lastName", "email", "phone" ], "type": "object" } } }, "required": true }, "responses": { "204": { "description": "No Content" } }, "security": [ { "bearerAuth": [] } ], "summary": "Add or Update Loan Officer", "tags": [ "loans" ] } }, "/v1/loans/{id}/quotes/{quoteId}/select": { "post": { "description": "Call this endpoint to record a borrower's selected quote.", "operationId": "postV1LoansByIdQuotesByQuoteIdSelect", "parameters": [ { "description": "The unique identifier of the loan application", "in": "path", "name": "id", "required": true, "schema": { "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" } }, { "description": "The unique identifier of the quote to select", "in": "path", "name": "quoteId", "required": true, "schema": { "example": "7c7a39cc-256f-4514-92b9-a75dc37a581d", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "quoteId": { "description": "The unique identifier of the selected quote", "example": "7c7a39cc-256f-4514-92b9-a75dc37a581d", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "required": [ "success", "quoteId" ], "type": "object" } }, "multipart/form-data": { "schema": { "properties": { "quoteId": { "description": "The unique identifier of the selected quote", "example": "7c7a39cc-256f-4514-92b9-a75dc37a581d", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "required": [ "success", "quoteId" ], "type": "object" } }, "text/plain": { "schema": { "properties": { "quoteId": { "description": "The unique identifier of the selected quote", "example": "7c7a39cc-256f-4514-92b9-a75dc37a581d", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "required": [ "success", "quoteId" ], "type": "object" } } }, "description": "Indicates that the quote was selected successfully" }, "500": { "content": { "application/json": { "schema": { "properties": { "error": { "example": "Failed to select quote", "type": "string" } }, "required": [ "error" ], "type": "object" } }, "multipart/form-data": { "schema": { "properties": { "error": { "example": "Failed to select quote", "type": "string" } }, "required": [ "error" ], "type": "object" } }, "text/plain": { "schema": { "properties": { "error": { "example": "Failed to select quote", "type": "string" } }, "required": [ "error" ], "type": "object" } } }, "description": "Error response when selecting quote" } }, "security": [ { "bearerAuth": [] } ], "summary": "Select Quote", "tags": [ "loans" ] } }, "/v1/loans/{id}/retrieve": { "patch": { "description": "Start the retrieve experience for a loan application", "operationId": "patchV1LoansByIdRetrieve", "parameters": [ { "description": "The unique identifier of the loan application", "in": "path", "name": "id", "required": true, "schema": { "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "url": { "default": "", "description": "URL to the retrieve experience for the loan application", "example": "https://sandbox-findmypolicy.itscovered.com/covered/2529e85d-6c0a-4fdb-8f36-5a6ffc4dc9bd", "format": "uri", "type": "string" } }, "required": [ "url" ], "type": "object" } }, "multipart/form-data": { "schema": { "properties": { "url": { "default": "", "description": "URL to the retrieve experience for the loan application", "example": "https://sandbox-findmypolicy.itscovered.com/covered/2529e85d-6c0a-4fdb-8f36-5a6ffc4dc9bd", "format": "uri", "type": "string" } }, "required": [ "url" ], "type": "object" } }, "text/plain": { "schema": { "properties": { "url": { "default": "", "description": "URL to the retrieve experience for the loan application", "example": "https://sandbox-findmypolicy.itscovered.com/covered/2529e85d-6c0a-4fdb-8f36-5a6ffc4dc9bd", "format": "uri", "type": "string" } }, "required": [ "url" ], "type": "object" } } }, "description": "Response containing the URL for the retrieve experience for a given loan application" } }, "security": [ { "bearerAuth": [] } ], "summary": "Start Retrieve Experience", "tags": [ "loans" ] } }, "/v1/loans/{id}/shop": { "get": { "operationId": "getV1LoansByIdShop", "parameters": [ { "description": "The unique identifier of the loan application", "in": "path", "name": "id", "required": true, "schema": { "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "contactPageUrl": { "description": "URL for the contact page for this loan application", "format": "uri", "type": "string" }, "hostedDisplayUrl": { "description": "The URL of the hosted display for the insurance options", "example": "https://getquote.itscovered.com/acmemortgage/v2/quote/home/693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "loanId": { "type": "string" }, "quotes": { "items": { "description": "The quote details", "properties": { "agentBridgeLink": { "description": "The bridge link for the agent to the carrier portal", "example": "https://example.com/agent-bridge", "type": "string" }, "carrierId": { "description": "The unique identifier of the carrier", "example": "cad7127b-787c-4e33-8240-7344292c2962", "type": "string" }, "carrierLogoUrl": { "description": "The URL of the carrier logo", "example": "https://example.com/carrier-logo.png", "type": "string" }, "carrierName": { "description": "The name of the carrier", "example": "Carrier Name", "type": "string" }, "coverages": { "properties": { "a": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "b": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "c": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "computers": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "d": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "e": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "f": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "hvac": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "mineSubsidence": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "waterBackup": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" } }, "required": [ "a", "b", "c", "d", "e", "f", "waterBackup" ], "type": "object" }, "deductibles": { "properties": { "dwelling": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "wind": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" } }, "required": [ "dwelling" ], "type": "object" }, "discounts": { "properties": { "autoBundle": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included" ], "type": "object" } }, "required": [ "autoBundle" ], "type": "object" }, "effectiveDate": { "description": "The effective date of the quote", "example": "2024-01-01", "format": "date", "type": "string" }, "endorsements": { "properties": { "floodZone": { "properties": { "included": { "type": "boolean" } }, "required": [ "included" ], "type": "object" }, "swimmingPool": { "properties": { "included": { "type": "boolean" } }, "required": [ "included" ], "type": "object" } }, "required": [ "swimmingPool", "floodZone" ], "type": "object" }, "id": { "description": "The unique identifier of the quote", "example": "7c7a39cc-256f-4514-92b9-a75dc37a581d", "type": "string" }, "monthlyPremium": { "description": "The monthly premium of the quote", "example": 100, "type": "number" }, "policyType": { "description": "The type of policy", "enum": [ "HO3", "HO5", "HO6" ], "example": "HO3" }, "premium": { "description": "The premium of the quote", "example": 1200, "type": "number" }, "status": { "description": "The status of the quote", "enum": [ "SUCCEEDED", "FAILED" ], "example": "SUCCEEDED" }, "termLengthMonths": { "description": "The term length of the quote in months", "example": 12, "type": "number" } }, "required": [ "id", "policyType", "premium", "monthlyPremium", "termLengthMonths", "status", "carrierId", "carrierName", "carrierLogoUrl", "agentBridgeLink", "endorsements", "deductibles", "coverages", "effectiveDate" ], "type": "object" }, "type": "array" }, "shortHostedDisplayUrl": { "description": "Short URL for the hosted borrower quote experience, when available", "format": "uri", "type": "string" }, "status": { "anyOf": [ { "const": "NOT_YET_RATED", "type": "string" }, { "const": "RC1_RATING", "type": "string" }, { "const": "RC1_RATED", "type": "string" }, { "const": "RC2_RATING", "type": "string" }, { "const": "RC2_RATED", "type": "string" }, { "const": "RC1_ERRORED", "type": "string" }, { "const": "CLOSED_WON", "type": "string" }, { "const": "CLOSED_LOST", "type": "string" } ], "description": "The status of the insurance options", "example": "RC1_RATING" } }, "required": [ "id", "loanId", "status", "hostedDisplayUrl", "quotes" ], "type": "object" } }, "multipart/form-data": { "schema": { "properties": { "contactPageUrl": { "description": "URL for the contact page for this loan application", "format": "uri", "type": "string" }, "hostedDisplayUrl": { "description": "The URL of the hosted display for the insurance options", "example": "https://getquote.itscovered.com/acmemortgage/v2/quote/home/693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "loanId": { "type": "string" }, "quotes": { "items": { "description": "The quote details", "properties": { "agentBridgeLink": { "description": "The bridge link for the agent to the carrier portal", "example": "https://example.com/agent-bridge", "type": "string" }, "carrierId": { "description": "The unique identifier of the carrier", "example": "cad7127b-787c-4e33-8240-7344292c2962", "type": "string" }, "carrierLogoUrl": { "description": "The URL of the carrier logo", "example": "https://example.com/carrier-logo.png", "type": "string" }, "carrierName": { "description": "The name of the carrier", "example": "Carrier Name", "type": "string" }, "coverages": { "properties": { "a": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "b": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "c": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "computers": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "d": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "e": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "f": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "hvac": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "mineSubsidence": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "waterBackup": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" } }, "required": [ "a", "b", "c", "d", "e", "f", "waterBackup" ], "type": "object" }, "deductibles": { "properties": { "dwelling": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "wind": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" } }, "required": [ "dwelling" ], "type": "object" }, "discounts": { "properties": { "autoBundle": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included" ], "type": "object" } }, "required": [ "autoBundle" ], "type": "object" }, "effectiveDate": { "description": "The effective date of the quote", "example": "2024-01-01", "format": "date", "type": "string" }, "endorsements": { "properties": { "floodZone": { "properties": { "included": { "type": "boolean" } }, "required": [ "included" ], "type": "object" }, "swimmingPool": { "properties": { "included": { "type": "boolean" } }, "required": [ "included" ], "type": "object" } }, "required": [ "swimmingPool", "floodZone" ], "type": "object" }, "id": { "description": "The unique identifier of the quote", "example": "7c7a39cc-256f-4514-92b9-a75dc37a581d", "type": "string" }, "monthlyPremium": { "description": "The monthly premium of the quote", "example": 100, "type": "number" }, "policyType": { "description": "The type of policy", "enum": [ "HO3", "HO5", "HO6" ], "example": "HO3" }, "premium": { "description": "The premium of the quote", "example": 1200, "type": "number" }, "status": { "description": "The status of the quote", "enum": [ "SUCCEEDED", "FAILED" ], "example": "SUCCEEDED" }, "termLengthMonths": { "description": "The term length of the quote in months", "example": 12, "type": "number" } }, "required": [ "id", "policyType", "premium", "monthlyPremium", "termLengthMonths", "status", "carrierId", "carrierName", "carrierLogoUrl", "agentBridgeLink", "endorsements", "deductibles", "coverages", "effectiveDate" ], "type": "object" }, "type": "array" }, "shortHostedDisplayUrl": { "description": "Short URL for the hosted borrower quote experience, when available", "format": "uri", "type": "string" }, "status": { "anyOf": [ { "const": "NOT_YET_RATED", "type": "string" }, { "const": "RC1_RATING", "type": "string" }, { "const": "RC1_RATED", "type": "string" }, { "const": "RC2_RATING", "type": "string" }, { "const": "RC2_RATED", "type": "string" }, { "const": "RC1_ERRORED", "type": "string" }, { "const": "CLOSED_WON", "type": "string" }, { "const": "CLOSED_LOST", "type": "string" } ], "description": "The status of the insurance options", "example": "RC1_RATING" } }, "required": [ "id", "loanId", "status", "hostedDisplayUrl", "quotes" ], "type": "object" } }, "text/plain": { "schema": { "properties": { "contactPageUrl": { "description": "URL for the contact page for this loan application", "format": "uri", "type": "string" }, "hostedDisplayUrl": { "description": "The URL of the hosted display for the insurance options", "example": "https://getquote.itscovered.com/acmemortgage/v2/quote/home/693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "loanId": { "type": "string" }, "quotes": { "items": { "description": "The quote details", "properties": { "agentBridgeLink": { "description": "The bridge link for the agent to the carrier portal", "example": "https://example.com/agent-bridge", "type": "string" }, "carrierId": { "description": "The unique identifier of the carrier", "example": "cad7127b-787c-4e33-8240-7344292c2962", "type": "string" }, "carrierLogoUrl": { "description": "The URL of the carrier logo", "example": "https://example.com/carrier-logo.png", "type": "string" }, "carrierName": { "description": "The name of the carrier", "example": "Carrier Name", "type": "string" }, "coverages": { "properties": { "a": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "b": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "c": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "computers": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "d": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "e": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "f": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "hvac": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "mineSubsidence": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "waterBackup": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" } }, "required": [ "a", "b", "c", "d", "e", "f", "waterBackup" ], "type": "object" }, "deductibles": { "properties": { "dwelling": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "wind": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" } }, "required": [ "dwelling" ], "type": "object" }, "discounts": { "properties": { "autoBundle": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included" ], "type": "object" } }, "required": [ "autoBundle" ], "type": "object" }, "effectiveDate": { "description": "The effective date of the quote", "example": "2024-01-01", "format": "date", "type": "string" }, "endorsements": { "properties": { "floodZone": { "properties": { "included": { "type": "boolean" } }, "required": [ "included" ], "type": "object" }, "swimmingPool": { "properties": { "included": { "type": "boolean" } }, "required": [ "included" ], "type": "object" } }, "required": [ "swimmingPool", "floodZone" ], "type": "object" }, "id": { "description": "The unique identifier of the quote", "example": "7c7a39cc-256f-4514-92b9-a75dc37a581d", "type": "string" }, "monthlyPremium": { "description": "The monthly premium of the quote", "example": 100, "type": "number" }, "policyType": { "description": "The type of policy", "enum": [ "HO3", "HO5", "HO6" ], "example": "HO3" }, "premium": { "description": "The premium of the quote", "example": 1200, "type": "number" }, "status": { "description": "The status of the quote", "enum": [ "SUCCEEDED", "FAILED" ], "example": "SUCCEEDED" }, "termLengthMonths": { "description": "The term length of the quote in months", "example": 12, "type": "number" } }, "required": [ "id", "policyType", "premium", "monthlyPremium", "termLengthMonths", "status", "carrierId", "carrierName", "carrierLogoUrl", "agentBridgeLink", "endorsements", "deductibles", "coverages", "effectiveDate" ], "type": "object" }, "type": "array" }, "shortHostedDisplayUrl": { "description": "Short URL for the hosted borrower quote experience, when available", "format": "uri", "type": "string" }, "status": { "anyOf": [ { "const": "NOT_YET_RATED", "type": "string" }, { "const": "RC1_RATING", "type": "string" }, { "const": "RC1_RATED", "type": "string" }, { "const": "RC2_RATING", "type": "string" }, { "const": "RC2_RATED", "type": "string" }, { "const": "RC1_ERRORED", "type": "string" }, { "const": "CLOSED_WON", "type": "string" }, { "const": "CLOSED_LOST", "type": "string" } ], "description": "The status of the insurance options", "example": "RC1_RATING" } }, "required": [ "id", "loanId", "status", "hostedDisplayUrl", "quotes" ], "type": "object" } } }, "description": "The insurance options for a loan application" } }, "security": [ { "bearerAuth": [] } ], "tags": [ "loans" ] }, "patch": { "operationId": "patchV1LoansByIdShop", "parameters": [ { "description": "The unique identifier of the loan application", "in": "path", "name": "id", "required": true, "schema": { "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "contactPageUrl": { "description": "URL for the contact page for this loan application", "format": "uri", "type": "string" }, "hostedDisplayUrl": { "description": "The URL to display the loan application shop", "example": "https://getquote.itscovered.com/acmemortgage/v2/quote/home/693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "loanId": { "description": "The identifier of the loan application in the loan system", "example": "1234567890", "type": "string" }, "shortHostedDisplayUrl": { "description": "Short URL for the hosted borrower quote experience, when available", "format": "uri", "type": "string" }, "status": { "description": "The status of the loan application shop", "enum": [ "NOT_YET_RATED", "RC1_RATING", "RC1_RATED", "RC2_RATING", "RC2_RATED", "RC1_ERRORED", "CLOSED_WON", "CLOSED_LOST" ], "example": "NOT_YET_RATED", "type": "string" } }, "required": [ "id", "loanId", "status", "hostedDisplayUrl" ], "type": "object" } }, "multipart/form-data": { "schema": { "properties": { "contactPageUrl": { "description": "URL for the contact page for this loan application", "format": "uri", "type": "string" }, "hostedDisplayUrl": { "description": "The URL to display the loan application shop", "example": "https://getquote.itscovered.com/acmemortgage/v2/quote/home/693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "loanId": { "description": "The identifier of the loan application in the loan system", "example": "1234567890", "type": "string" }, "shortHostedDisplayUrl": { "description": "Short URL for the hosted borrower quote experience, when available", "format": "uri", "type": "string" }, "status": { "description": "The status of the loan application shop", "enum": [ "NOT_YET_RATED", "RC1_RATING", "RC1_RATED", "RC2_RATING", "RC2_RATED", "RC1_ERRORED", "CLOSED_WON", "CLOSED_LOST" ], "example": "NOT_YET_RATED", "type": "string" } }, "required": [ "id", "loanId", "status", "hostedDisplayUrl" ], "type": "object" } }, "text/plain": { "schema": { "properties": { "contactPageUrl": { "description": "URL for the contact page for this loan application", "format": "uri", "type": "string" }, "hostedDisplayUrl": { "description": "The URL to display the loan application shop", "example": "https://getquote.itscovered.com/acmemortgage/v2/quote/home/693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "loanId": { "description": "The identifier of the loan application in the loan system", "example": "1234567890", "type": "string" }, "shortHostedDisplayUrl": { "description": "Short URL for the hosted borrower quote experience, when available", "format": "uri", "type": "string" }, "status": { "description": "The status of the loan application shop", "enum": [ "NOT_YET_RATED", "RC1_RATING", "RC1_RATED", "RC2_RATING", "RC2_RATED", "RC1_ERRORED", "CLOSED_WON", "CLOSED_LOST" ], "example": "NOT_YET_RATED", "type": "string" } }, "required": [ "id", "loanId", "status", "hostedDisplayUrl" ], "type": "object" } } }, "description": "The response from the loan application shop" } }, "security": [ { "bearerAuth": [] } ], "tags": [ "loans" ] } }, "/v1/loans/{id}/shop/display": { "get": { "description": "Get display information for a quote", "operationId": "getV1LoansByIdShopDisplay", "parameters": [ { "description": "The unique identifier of the loan application", "in": "path", "name": "id", "required": true, "schema": { "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "contactPageUrl": { "description": "URL for the contact page for this loan application", "format": "uri", "type": "string" }, "hostedDisplayUrl": { "description": "The URL of the hosted display for the insurance options", "example": "https://getquote.itscovered.com/acmemortgage/v2/quote/home/693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "loanId": { "type": "string" }, "quotes": { "items": { "description": "The quote details", "properties": { "agentBridgeLink": { "description": "The bridge link for the agent to the carrier portal", "example": "https://example.com/agent-bridge", "type": "string" }, "carrierId": { "description": "The unique identifier of the carrier", "example": "cad7127b-787c-4e33-8240-7344292c2962", "type": "string" }, "carrierLogoUrl": { "description": "The URL of the carrier logo", "example": "https://example.com/carrier-logo.png", "type": "string" }, "carrierName": { "description": "The name of the carrier", "example": "Carrier Name", "type": "string" }, "coverages": { "properties": { "a": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "b": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "c": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "computers": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "d": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "e": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "f": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "hvac": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "mineSubsidence": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "waterBackup": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" } }, "required": [ "a", "b", "c", "d", "e", "f", "waterBackup" ], "type": "object" }, "deductibles": { "properties": { "dwelling": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "wind": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" } }, "required": [ "dwelling" ], "type": "object" }, "discounts": { "properties": { "autoBundle": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included" ], "type": "object" } }, "required": [ "autoBundle" ], "type": "object" }, "effectiveDate": { "description": "The effective date of the quote", "example": "2024-01-01", "format": "date", "type": "string" }, "endorsements": { "properties": { "floodZone": { "properties": { "included": { "type": "boolean" } }, "required": [ "included" ], "type": "object" }, "swimmingPool": { "properties": { "included": { "type": "boolean" } }, "required": [ "included" ], "type": "object" } }, "required": [ "swimmingPool", "floodZone" ], "type": "object" }, "id": { "description": "The unique identifier of the quote", "example": "7c7a39cc-256f-4514-92b9-a75dc37a581d", "type": "string" }, "monthlyPremium": { "description": "The monthly premium of the quote", "example": 100, "type": "number" }, "policyType": { "description": "The type of policy", "enum": [ "HO3", "HO5", "HO6" ], "example": "HO3" }, "premium": { "description": "The premium of the quote", "example": 1200, "type": "number" }, "status": { "description": "The status of the quote", "enum": [ "SUCCEEDED", "FAILED" ], "example": "SUCCEEDED" }, "termLengthMonths": { "description": "The term length of the quote in months", "example": 12, "type": "number" } }, "required": [ "id", "policyType", "premium", "monthlyPremium", "termLengthMonths", "status", "carrierId", "carrierName", "carrierLogoUrl", "agentBridgeLink", "endorsements", "deductibles", "coverages", "effectiveDate" ], "type": "object" }, "type": "array" }, "shortHostedDisplayUrl": { "description": "Short URL for the hosted borrower quote experience, when available", "format": "uri", "type": "string" }, "status": { "anyOf": [ { "const": "NOT_YET_RATED", "type": "string" }, { "const": "RC1_RATING", "type": "string" }, { "const": "RC1_RATED", "type": "string" }, { "const": "RC2_RATING", "type": "string" }, { "const": "RC2_RATED", "type": "string" }, { "const": "RC1_ERRORED", "type": "string" }, { "const": "CLOSED_WON", "type": "string" }, { "const": "CLOSED_LOST", "type": "string" } ], "description": "The status of the insurance options", "example": "RC1_RATING" } }, "required": [ "id", "loanId", "status", "hostedDisplayUrl", "quotes" ], "type": "object" } }, "multipart/form-data": { "schema": { "properties": { "contactPageUrl": { "description": "URL for the contact page for this loan application", "format": "uri", "type": "string" }, "hostedDisplayUrl": { "description": "The URL of the hosted display for the insurance options", "example": "https://getquote.itscovered.com/acmemortgage/v2/quote/home/693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "loanId": { "type": "string" }, "quotes": { "items": { "description": "The quote details", "properties": { "agentBridgeLink": { "description": "The bridge link for the agent to the carrier portal", "example": "https://example.com/agent-bridge", "type": "string" }, "carrierId": { "description": "The unique identifier of the carrier", "example": "cad7127b-787c-4e33-8240-7344292c2962", "type": "string" }, "carrierLogoUrl": { "description": "The URL of the carrier logo", "example": "https://example.com/carrier-logo.png", "type": "string" }, "carrierName": { "description": "The name of the carrier", "example": "Carrier Name", "type": "string" }, "coverages": { "properties": { "a": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "b": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "c": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "computers": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "d": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "e": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "f": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "hvac": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "mineSubsidence": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "waterBackup": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" } }, "required": [ "a", "b", "c", "d", "e", "f", "waterBackup" ], "type": "object" }, "deductibles": { "properties": { "dwelling": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "wind": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" } }, "required": [ "dwelling" ], "type": "object" }, "discounts": { "properties": { "autoBundle": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included" ], "type": "object" } }, "required": [ "autoBundle" ], "type": "object" }, "effectiveDate": { "description": "The effective date of the quote", "example": "2024-01-01", "format": "date", "type": "string" }, "endorsements": { "properties": { "floodZone": { "properties": { "included": { "type": "boolean" } }, "required": [ "included" ], "type": "object" }, "swimmingPool": { "properties": { "included": { "type": "boolean" } }, "required": [ "included" ], "type": "object" } }, "required": [ "swimmingPool", "floodZone" ], "type": "object" }, "id": { "description": "The unique identifier of the quote", "example": "7c7a39cc-256f-4514-92b9-a75dc37a581d", "type": "string" }, "monthlyPremium": { "description": "The monthly premium of the quote", "example": 100, "type": "number" }, "policyType": { "description": "The type of policy", "enum": [ "HO3", "HO5", "HO6" ], "example": "HO3" }, "premium": { "description": "The premium of the quote", "example": 1200, "type": "number" }, "status": { "description": "The status of the quote", "enum": [ "SUCCEEDED", "FAILED" ], "example": "SUCCEEDED" }, "termLengthMonths": { "description": "The term length of the quote in months", "example": 12, "type": "number" } }, "required": [ "id", "policyType", "premium", "monthlyPremium", "termLengthMonths", "status", "carrierId", "carrierName", "carrierLogoUrl", "agentBridgeLink", "endorsements", "deductibles", "coverages", "effectiveDate" ], "type": "object" }, "type": "array" }, "shortHostedDisplayUrl": { "description": "Short URL for the hosted borrower quote experience, when available", "format": "uri", "type": "string" }, "status": { "anyOf": [ { "const": "NOT_YET_RATED", "type": "string" }, { "const": "RC1_RATING", "type": "string" }, { "const": "RC1_RATED", "type": "string" }, { "const": "RC2_RATING", "type": "string" }, { "const": "RC2_RATED", "type": "string" }, { "const": "RC1_ERRORED", "type": "string" }, { "const": "CLOSED_WON", "type": "string" }, { "const": "CLOSED_LOST", "type": "string" } ], "description": "The status of the insurance options", "example": "RC1_RATING" } }, "required": [ "id", "loanId", "status", "hostedDisplayUrl", "quotes" ], "type": "object" } }, "text/plain": { "schema": { "properties": { "contactPageUrl": { "description": "URL for the contact page for this loan application", "format": "uri", "type": "string" }, "hostedDisplayUrl": { "description": "The URL of the hosted display for the insurance options", "example": "https://getquote.itscovered.com/acmemortgage/v2/quote/home/693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "loanId": { "type": "string" }, "quotes": { "items": { "description": "The quote details", "properties": { "agentBridgeLink": { "description": "The bridge link for the agent to the carrier portal", "example": "https://example.com/agent-bridge", "type": "string" }, "carrierId": { "description": "The unique identifier of the carrier", "example": "cad7127b-787c-4e33-8240-7344292c2962", "type": "string" }, "carrierLogoUrl": { "description": "The URL of the carrier logo", "example": "https://example.com/carrier-logo.png", "type": "string" }, "carrierName": { "description": "The name of the carrier", "example": "Carrier Name", "type": "string" }, "coverages": { "properties": { "a": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "b": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "c": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "computers": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "d": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "e": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "f": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "hvac": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "mineSubsidence": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "waterBackup": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" } }, "required": [ "a", "b", "c", "d", "e", "f", "waterBackup" ], "type": "object" }, "deductibles": { "properties": { "dwelling": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "wind": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" } }, "required": [ "dwelling" ], "type": "object" }, "discounts": { "properties": { "autoBundle": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included" ], "type": "object" } }, "required": [ "autoBundle" ], "type": "object" }, "effectiveDate": { "description": "The effective date of the quote", "example": "2024-01-01", "format": "date", "type": "string" }, "endorsements": { "properties": { "floodZone": { "properties": { "included": { "type": "boolean" } }, "required": [ "included" ], "type": "object" }, "swimmingPool": { "properties": { "included": { "type": "boolean" } }, "required": [ "included" ], "type": "object" } }, "required": [ "swimmingPool", "floodZone" ], "type": "object" }, "id": { "description": "The unique identifier of the quote", "example": "7c7a39cc-256f-4514-92b9-a75dc37a581d", "type": "string" }, "monthlyPremium": { "description": "The monthly premium of the quote", "example": 100, "type": "number" }, "policyType": { "description": "The type of policy", "enum": [ "HO3", "HO5", "HO6" ], "example": "HO3" }, "premium": { "description": "The premium of the quote", "example": 1200, "type": "number" }, "status": { "description": "The status of the quote", "enum": [ "SUCCEEDED", "FAILED" ], "example": "SUCCEEDED" }, "termLengthMonths": { "description": "The term length of the quote in months", "example": 12, "type": "number" } }, "required": [ "id", "policyType", "premium", "monthlyPremium", "termLengthMonths", "status", "carrierId", "carrierName", "carrierLogoUrl", "agentBridgeLink", "endorsements", "deductibles", "coverages", "effectiveDate" ], "type": "object" }, "type": "array" }, "shortHostedDisplayUrl": { "description": "Short URL for the hosted borrower quote experience, when available", "format": "uri", "type": "string" }, "status": { "anyOf": [ { "const": "NOT_YET_RATED", "type": "string" }, { "const": "RC1_RATING", "type": "string" }, { "const": "RC1_RATED", "type": "string" }, { "const": "RC2_RATING", "type": "string" }, { "const": "RC2_RATED", "type": "string" }, { "const": "RC1_ERRORED", "type": "string" }, { "const": "CLOSED_WON", "type": "string" }, { "const": "CLOSED_LOST", "type": "string" } ], "description": "The status of the insurance options", "example": "RC1_RATING" } }, "required": [ "id", "loanId", "status", "hostedDisplayUrl", "quotes" ], "type": "object" } } }, "description": "The insurance options for a loan application" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get quote display", "tags": [ "loans" ] } }, "/v1/policies/{id}": { "get": { "operationId": "getV1PoliciesById", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "cancellationDate": { "anyOf": [ { "description": "The cancellation date of the policy", "example": "2025-07-01", "type": "string" }, { "type": "null" } ] }, "carrier": { "type": "string" }, "coverages": { "anyOf": [ { "items": { "properties": { "a": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "b": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "c": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "computers": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "d": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "e": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "f": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "hvac": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "mineSubsidence": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "waterBackup": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" } }, "required": [ "a", "b", "c", "d", "e", "f", "waterBackup" ], "type": "object" }, "type": "array" }, { "type": "null" } ] }, "documents": { "anyOf": [ { "items": { "properties": { "id": { "description": "The unique identifier for the policy document", "example": "9b1bde3a-62d5-43fe-a346-c0c6a2e28358", "type": "string" }, "name": { "description": "The file name of the policy document", "example": "Nationwide-EOI-May-01-2025-07-03-16-7707-PM", "type": "string" }, "type": { "description": "The type of the policy document", "enum": [ "signed_application_document", "insurance_binder_document", "home_dec_page_document", "endorsement_document", "eoi_document" ], "example": "eoi_document", "type": "string" }, "url": { "description": "The signed URL to download the policy document", "example": "https://41847538.cdnp1.hubspotusercontent-na1.net/hubfs/11847538/crm-properties-file-values/Nationwide-EOI-May-01-2025-07-03-16-7707-PM.pdf?Expires=1746212942", "type": "string" } }, "required": [ "id", "name", "type", "url" ], "type": "object" }, "type": "array" }, { "type": "null" } ] }, "effectiveDate": { "description": "The effective date of the policy", "example": "2025-03-01", "type": "string" }, "expirationDate": { "description": "The expiration date of the policy", "example": "2026-03-01", "type": "string" }, "externalId": { "anyOf": [ { "description": "The external ID of the policy", "example": "1234567890", "type": "string" }, { "type": "null" } ] }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "loanId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "policyNumber": { "description": "The policy number of the policy", "example": "AB325023234-03", "type": "string" }, "policyType": { "description": "The type of policy", "enum": [ "HO3", "HO6", "EARTHQUAKE", "FLOOD", "DWELLING_FIRE", "WIND" ], "example": "HO3", "type": "string" }, "premium": { "anyOf": [ { "description": "The premium of the policy", "example": 1200, "type": "number" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "termLength": { "anyOf": [ { "description": "The term length of the policy in months", "example": 12, "type": "number" }, { "type": "null" } ] } }, "required": [ "id", "carrier", "policyNumber", "policyType", "effectiveDate", "expirationDate" ], "type": "object" } }, "multipart/form-data": { "schema": { "properties": { "cancellationDate": { "anyOf": [ { "description": "The cancellation date of the policy", "example": "2025-07-01", "type": "string" }, { "type": "null" } ] }, "carrier": { "type": "string" }, "coverages": { "anyOf": [ { "items": { "properties": { "a": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "b": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "c": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "computers": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "d": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "e": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "f": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "hvac": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "mineSubsidence": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "waterBackup": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" } }, "required": [ "a", "b", "c", "d", "e", "f", "waterBackup" ], "type": "object" }, "type": "array" }, { "type": "null" } ] }, "documents": { "anyOf": [ { "items": { "properties": { "id": { "description": "The unique identifier for the policy document", "example": "9b1bde3a-62d5-43fe-a346-c0c6a2e28358", "type": "string" }, "name": { "description": "The file name of the policy document", "example": "Nationwide-EOI-May-01-2025-07-03-16-7707-PM", "type": "string" }, "type": { "description": "The type of the policy document", "enum": [ "signed_application_document", "insurance_binder_document", "home_dec_page_document", "endorsement_document", "eoi_document" ], "example": "eoi_document", "type": "string" }, "url": { "description": "The signed URL to download the policy document", "example": "https://41847538.cdnp1.hubspotusercontent-na1.net/hubfs/11847538/crm-properties-file-values/Nationwide-EOI-May-01-2025-07-03-16-7707-PM.pdf?Expires=1746212942", "type": "string" } }, "required": [ "id", "name", "type", "url" ], "type": "object" }, "type": "array" }, { "type": "null" } ] }, "effectiveDate": { "description": "The effective date of the policy", "example": "2025-03-01", "type": "string" }, "expirationDate": { "description": "The expiration date of the policy", "example": "2026-03-01", "type": "string" }, "externalId": { "anyOf": [ { "description": "The external ID of the policy", "example": "1234567890", "type": "string" }, { "type": "null" } ] }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "loanId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "policyNumber": { "description": "The policy number of the policy", "example": "AB325023234-03", "type": "string" }, "policyType": { "description": "The type of policy", "enum": [ "HO3", "HO6", "EARTHQUAKE", "FLOOD", "DWELLING_FIRE", "WIND" ], "example": "HO3", "type": "string" }, "premium": { "anyOf": [ { "description": "The premium of the policy", "example": 1200, "type": "number" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "termLength": { "anyOf": [ { "description": "The term length of the policy in months", "example": 12, "type": "number" }, { "type": "null" } ] } }, "required": [ "id", "carrier", "policyNumber", "policyType", "effectiveDate", "expirationDate" ], "type": "object" } }, "text/plain": { "schema": { "properties": { "cancellationDate": { "anyOf": [ { "description": "The cancellation date of the policy", "example": "2025-07-01", "type": "string" }, { "type": "null" } ] }, "carrier": { "type": "string" }, "coverages": { "anyOf": [ { "items": { "properties": { "a": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "b": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "c": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "computers": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "d": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "e": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "f": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "hvac": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "mineSubsidence": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" }, "waterBackup": { "properties": { "amount": { "type": "number" }, "included": { "type": "boolean" } }, "required": [ "included", "amount" ], "type": "object" } }, "required": [ "a", "b", "c", "d", "e", "f", "waterBackup" ], "type": "object" }, "type": "array" }, { "type": "null" } ] }, "documents": { "anyOf": [ { "items": { "properties": { "id": { "description": "The unique identifier for the policy document", "example": "9b1bde3a-62d5-43fe-a346-c0c6a2e28358", "type": "string" }, "name": { "description": "The file name of the policy document", "example": "Nationwide-EOI-May-01-2025-07-03-16-7707-PM", "type": "string" }, "type": { "description": "The type of the policy document", "enum": [ "signed_application_document", "insurance_binder_document", "home_dec_page_document", "endorsement_document", "eoi_document" ], "example": "eoi_document", "type": "string" }, "url": { "description": "The signed URL to download the policy document", "example": "https://41847538.cdnp1.hubspotusercontent-na1.net/hubfs/11847538/crm-properties-file-values/Nationwide-EOI-May-01-2025-07-03-16-7707-PM.pdf?Expires=1746212942", "type": "string" } }, "required": [ "id", "name", "type", "url" ], "type": "object" }, "type": "array" }, { "type": "null" } ] }, "effectiveDate": { "description": "The effective date of the policy", "example": "2025-03-01", "type": "string" }, "expirationDate": { "description": "The expiration date of the policy", "example": "2026-03-01", "type": "string" }, "externalId": { "anyOf": [ { "description": "The external ID of the policy", "example": "1234567890", "type": "string" }, { "type": "null" } ] }, "id": { "description": "The unique identifier of the loan application", "example": "693f2f46-69ff-4f20-a4d9-abe982d34fd4", "type": "string" }, "loanId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "policyNumber": { "description": "The policy number of the policy", "example": "AB325023234-03", "type": "string" }, "policyType": { "description": "The type of policy", "enum": [ "HO3", "HO6", "EARTHQUAKE", "FLOOD", "DWELLING_FIRE", "WIND" ], "example": "HO3", "type": "string" }, "premium": { "anyOf": [ { "description": "The premium of the policy", "example": 1200, "type": "number" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "termLength": { "anyOf": [ { "description": "The term length of the policy in months", "example": 12, "type": "number" }, { "type": "null" } ] } }, "required": [ "id", "carrier", "policyNumber", "policyType", "effectiveDate", "expirationDate" ], "type": "object" } } }, "description": "Bound insurance policy details" } }, "security": [ { "bearerAuth": [] } ], "tags": [ "policies" ] } } }, "servers": [ { "url": "https://sandbox-api.itscovered.com/lenders" } ], "tags": [ { "description": "Health check", "name": "health" }, { "description": "Loans", "name": "loans" }, { "description": "Policies", "name": "policies" }, { "description": "Authentication", "name": "auth" } ] }