# Create a mortgage search with the Mortgage Brain provider

**POST /api/v1/addons/mortgagebrain/mortgage-search**




## Servers
- https://api.plannrcrm.com: https://api.plannrcrm.com ()


## Authentication methods
- Personal access token & O auth2


## Parameters



### Body: application/json (object)

- **applicants** (array[object])
  The applicants for the mortgage search. Must be at least one and no more than two.
- **case_uuids** (array[string(uuid)])
  An optional array of case UUIDs to associate to the mortgage search
- **oauth_connection_uuid** (string(uuid))
  An optional OAuth2 connection UUID to overwrite the default behaviour (which is to pick the first Mortgage Brain OAuth2 connection)
- **proceed** (boolean)
  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.


## Responses
### 200


#### Body: application/json (object)
- **uuid** (string)
  The UUID of the resource.
- **created_at** (string)
  The timestamp of when the resource was created.
- **updated_at** (string)
  The timestamp of when the resource was updated.
- **status** (string)
  The status of the mortgage search
- **provider** (string)
  The provider that the mortgage search is for
- **provider_reference** (string)
  The provider reference of the mortgage search
- **provider_data** (array)
  Any provider data related to the mortgage search
- **applicants** (array[object])
  The applicants of the mortgage search
- **cases** (array[object])
  The cases that are related to the mortgage search


[Powered by Bump.sh](https://bump.sh)