Create a mortgage search with the Mortgage Brain provider Run in API Explorer
Ask AI
Body
-
The applicants for the mortgage search. Must be at least one and no more than two.
-
An optional array of case UUIDs to associate to the mortgage search
-
An optional OAuth2 connection UUID to overwrite the default behaviour (which is to pick the first Mortgage Brain OAuth2 connection)
-
This parameter can be used to indicate whether to proceed with creating the mortgage search or not. If false, a 202 response will be returned without creating the search. This can be used to validate the data before continuing.
POST
/api/v1/addons/mortgagebrain/mortgage-search
curl \
--request POST 'https://api.plannrcrm.com/api/v1/addons/mortgagebrain/mortgage-search' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"applicants":[{"title":"mr","account_uuid":"1c5e28da-29d1-4b77-b2bb-e65c6bc39a27"}],"case_uuids":["c94b35b9-6ecf-46cc-858b-74a621e211be","2768e763-567a-4117-8a53-b802e29037dd","638f77ee-36ec-4acf-b9d3-462c83c48571"],"oauth_connection_uuid":"ed8ab270-f6ff-4ac5-b0ad-aa9e71b3639f","proceed":true}'
Request examples
{
"applicants": [
{
"title": "mr",
"account_uuid": "1c5e28da-29d1-4b77-b2bb-e65c6bc39a27"
}
],
"case_uuids": [
"c94b35b9-6ecf-46cc-858b-74a621e211be",
"2768e763-567a-4117-8a53-b802e29037dd",
"638f77ee-36ec-4acf-b9d3-462c83c48571"
],
"oauth_connection_uuid": "ed8ab270-f6ff-4ac5-b0ad-aa9e71b3639f",
"proceed": true
}
Response examples (200)
{
"name": "My Mortgage Search",
"uuid": "78d662ef-6c3b-4aad-94d5-16c0fb1d907a",
"cases": [
{
"name": "finance",
"slug": "finance",
"type": "App\\Http\\Resources\\CasesTypeResource",
"uuid": "773784bc-3997-4be5-b645-e1c06f3acb7e",
"plans": "App\\Http\\Resources\\Plans\\PlanResource",
"value": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
}
},
"status": "App\\Http\\Resources\\CasesStatusResource",
"review_at": "2026-02-26T15:22:28+00:00",
"created_at": "2026-02-26T15:22:28+00:00",
"updated_at": "2026-02-26T15:22:28+00:00",
"group_uuids": [
"3ebd2982-670a-4b84-b6c6-8a6425a9cc09"
],
"completed_at": "2026-02-26T15:22:28+00:00",
"participants": "App\\Http\\Resources\\AccountResource",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"status_position": 4,
"task_board_uuid": "6745ac84-9230-4059-8a77-b1c87f1215d9",
"assigned_to_uuids": [
"d757dea4-bbbd-4189-926d-5f2d674d7d35"
],
"participants_count": 4
}
],
"files": [
{
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Welcome to Plannr",
"path": "Gareth Thompson/Subfolder/Welcome to Plannr.pdf",
"size": "21691783",
"tags": "App\\Http\\Resources\\TagResource",
"type": "type",
"uuid": "99b3e2a7-de0c-4c9f-ac9f-7346e32153a4",
"folder": "App\\Http\\Resources\\FolderResource",
"status": "uploaded",
"account": "App\\Http\\Resources\\MinimalAccountResource",
"filename": "Welcome to Plannr.pdf",
"progress": "100",
"extension": "pdf",
"navigator": {
"model_type": "account",
"model_uuid": "f9e1f30d-f88a-4ef4-98f8-45b1dd504772"
},
"created_at": "2026-02-26T15:22:28+00:00",
"updated_at": "2026-02-26T15:22:28+00:00",
"folder_name": "folder 2",
"uploaded_at": "2026-02-26T15:22:28+00:00",
"documentable": "Object",
"download_url": "https://api.plannrcrm.com/file/31ef205a-b9ac-48cf-bb35-1eb6b34c9b36/download",
"last_modified": "2026-02-26T15:22:28+00:00",
"documentable_type": "account",
"original_created_at": "2026-02-26T15:22:28+00:00"
}
],
"status": "pending",
"products": [
{
"uuid": "98e04996-7eb3-4570-a207-e9cc7cbf80d0",
"files": "App\\Http\\Resources\\FileResource",
"created_at": "2026-02-26T15:22:28+00:00",
"updated_at": "2026-02-26T15:22:28+00:00",
"lender_name": "HSBC",
"product_title": "5% Fixed Rate - 5 year",
"provider_reference": "example-reference",
"provider_scenario_data": [],
"provider_scenario_name": "Single Applicant, Small Deposit"
}
],
"provider": "Mortgage Brain",
"applicants": [
{
"uuid": "d2aec201-6fd8-4ebc-909b-81713f4bc900",
"account": "App\\Http\\Resources\\MinimalAccountResource",
"created_at": "2026-02-26T15:22:28+00:00",
"updated_at": "2026-02-26T15:22:28+00:00"
}
],
"created_at": "2026-02-26T15:22:28+00:00",
"updated_at": "2026-02-26T15:22:28+00:00",
"provider_data": [],
"provider_reference": "123456789"
}