Branch

List Branches

This endpoint lists branches

HTTP Request

POST https://sandbox.reggora.io/lender/branch

Request Query Parameters

Parameter	Default	Description
limit	50	Number of branches to return in page
offset	0	Number of branches to skip for paginated results

Response List Attributes

Attribute	Description	Type
branch_identifier	Unique identifier	string
name	Branch name	string
address	Street address	string
city	City	string
state	State	string
zip	Zipcode	string
branch_classification	Options: [‘retail’, ‘wholesale’]	string
is_joint_venture	Boolean / Default is False	bool
contact_phone_number	Phone number	string
contact_email	Email address	string
loan_officers	List of loan officers	Dict
parent_branch_identifier	The branch identifier of the parent	nullable string
exists_in_hierarchy	Flag if branch is in the lender hierarchy	bool

Specific Errors

Status Code	Message
400	Invalid integration header
400	User is not in a lender.

Errors not encapsulated in this custom error list can be interpreted as standard REST RFC errors.

Example Request

import requests

headers = {
    'Authorization': 'Bearer {}'.format(REGGORA_AUTH_TOKEN),
    'integration': '{}'.format(REGGORA_INTEGRATION_KEY)
}

response = requests.get('https://sandbox.reggora.io/lender/branch', headers=headers)

Example Response

{
    "data": [
        {
            "branch_id": "5d6ecfdb69655808d5b3d012",
            "branch_identifier": "test_branch_1",
            "name": "test branch",
            "address": "123 Main St",
            "city": "Boston",
            "state": "MA",
            "zip": "90210",
            "branch_classification": "retail",
            "is_joint_venture": false,
            "contact_phone_number": "555-555-5555",
            "contact_email": "email@testreggora.com",
            "loan_officers": [],
            "parent_branch_identifier": "test_branch_2",
            "exists_in_hierarchy": true
        }
    ],
    "status": 200
}

Create Branch

This endpoint creates a branch

HTTP Request

POST https://sandbox.reggora.io/lender/branch

Request Body Parameters

Parameter	Description	Required
branch_identifier	Unique identifier	True
name	Branch name	False
address	Street address	False
branch_classification	Options: [‘retail’, ‘wholesale’]	False
is_joint_venture	Boolean / Default is False	False
city	City	False
state	State	False
ZIP	Zipcode	False
contact_phone_number	Phone number	False
contact_email	Email address	False
parent_branch_identifier	Unique identifier of parent	False

Response Body Attributes

Attribute	Description	Type
branch_identifier	Unique identifier	string
name	Branch name	string
address	Street address	string
city	City	string
state	State	string
ZIP	Zipcode	string
branch_classification	Options: [‘retail’, ‘wholesale’]	string
is_joint_venture	Boolean / Default is False	bool
contact_phone_number	Phone number	string
contact_email	Email address	string
loan_officers	List of loan officers	Dict
parent_branch_identifier	The branch identifier of the parent	nullable string
exists_in_hierarchy	Flag if branch is in the lender hierarchy	bool

Specific Errors

Status Code	Message
400	Invalid integration header
400	User is not in a lender.
400	Parent branch with branch_identifier: <{parent_branch_identifier}> does not exist in hierarchy.
400	Hierarchy relationship invalid - loop detected. Parent branch <{parent_branch_identifier}> is the child branch of <{existing_branch.branch_identifier}>.
404	Branch <branch_identifier> not found.
409	Active branch with branch_identifier: <{branch_identifier}> already exists.
500	Error creating branch with branch_identifier: <{branch_identifier}>.

Errors not encapsulated in this custom error list can be interpreted as standard REST RFC errors.

Example Request

import requests

headers = {
    'Authorization': 'Bearer {}'.format(REGGORA_AUTH_TOKEN),
    'integration': '{}'.format(REGGORA_INTEGRATION_KEY)
}

body = {
    "branch_identifier" : "Location 123456",
    "name" : "New Branch",
    "address" : "822 Main St",
    "branch_classification" : "retail",
    "is_joint_venture": False,
    "city" : "Boston",
    "state" : "MA",
    "ZIP" : "06201",
    "contact_phone_number" : "555-555-5555",
    "contact_email" : "user@reggorapartner.com",
    "parent_branch_identifier": "ParentBranch202"
}

response = requests.post('https://sandbox.reggora.io/lender/branch', headers=headers)

Example Response

{
    "data": {
        "branch": {
            "branch_id": "5d6ecfdb69655808d5b3d012",
            "branch_identifier": "test_branch_1",
            "name": "test branch",
            "address": "123 Main St",
            "city": "Boston",
            "state": "MA",
            "ZIP": "90210",
            "branch_classification": "retail",
            "is_joint_venture": false,
            "contact_phone_number": "555-555-5555",
            "contact_email": "email@testreggora.com",
            "loan_officers": [],
            "parent_branch_identifier": "test_branch_2",
            "exists_in_hierarchy": true
        }
    },
    "status": 201
}

Delete Branch

This endpoint soft deletes a branch

HTTP Request

DELETE https://sandbox.reggora.io/lender/branch/<branch_identifier>

URL Parameters

Parameter	Description
branch_identifer	The unique identifier of the branch.

Specific Errors

Status Code	Message
400	Invalid integration header
400	User is not in a lender.
400	Unable to delete branch <{branch_identifier}> — it is a parent branch.
404	Branch <branch_identifier> not found.
500	Error deleting branch with branch_identifier: <branch_identifier>.

Errors not encapsulated in this custom error list can be interpreted as standard REST RFC errors.

Example Request

import requests

headers = {
    'Authorization': 'Bearer {}'.format(REGGORA_AUTH_TOKEN),
    'integration': '{}'.format(REGGORA_INTEGRATION_KEY)
}

response = requests.delete('https://sandbox.reggora.io/lender/branch/<branch_identifier>', headers=headers)

Example Response

{
    "success": "Branch <branch_identifier> has been deleted.",
    "status": 200
}

Delete Branch and Reassign Loan Officers

This endpoint soft deletes a branch and reassigns the loan officers to a target branch specified in the body of the request.

HTTP Request

DELETE https://sandbox.reggora.io/lender/branch/<branch_identifier>/reassign

URL Parameters

Parameter	Description
branch_identifer	The unique identifier of the branch.

Specific Errors

Status Code	Message
400	Invalid integration header
400	User is not in a lender.
400	Unable to delete branch <{branch_identifier}> — it is a parent branch.
400	Missing ‘target_branch_identifier’ in the body to reassign loan officers to.
404	Branch <branch_identifier> not found.
404	Target branch not found for target_branch_identifier: <target_branch_identifier>.
500	Error deleting branch with branch_identifier: <branch_identifier>.

Errors not encapsulated in this custom error list can be interpreted as standard REST RFC errors.

Example Request

import requests

headers = {
    'Authorization': 'Bearer {}'.format(REGGORA_AUTH_TOKEN),
    'integration': '{}'.format(REGGORA_INTEGRATION_KEY)
}

body = {
    "target_branch_identifier" : "branch_identifier_123",
}

response = requests.delete('https://sandbox.reggora.io/lender/branch/<branch_identifier>/reassign', headers=headers)

Example Response

{
    "success": "Branch <branch_identifier> has been deleted.",
    "status": 200
}

Update Branch

This endpoint updates a branch

HTTP Request

PUT https://sandbox.reggora.io/lender/branch/<branch_identifier>?update_hierarchy=false

URL Parameters

Parameter	Description
branch_identifer	The unique identifier of the branch.

URL Query Parameters

Parameter	Description
update_hierarchy	An optional boolean that determines whether or not to update branch hierarchy. Defaults to False.

Response Body Attributes

Attribute	Description	Type
branch_identifier	Unique identifier	string
name	Branch name	string
address	Street address	string
city	City	string
state	State	string
ZIP	Zipcode	string
branch_classification	Options: [‘retail’, ‘wholesale’]	string
is_joint_venture	Boolean / Default is False	bool
contact_phone_number	Phone number	string
contact_email	Email address	string
loan_officers	List of loan officers	Dict
parent_branch_identifier	The branch identifier of the parent	nullable string
exists_in_hierarchy	Flag if branch is in the lender hierarchy	bool

Loan Officer

Attribute	Description	Type
id	Unique identifier	string
email	Email address	string
firstname	First Name	string
lastname	Last Name	string
phone_number	Phone number	string
created	Date Created UTC	string

Specific Errors

Status Code	Message
400	Invalid integration header
400	User is not in a lender.
400	Parent branch with branch_identifier: <{parent_branch_identifier}> does not exist in hierarchy.
400	Missing ‘parent_branch_identifier’ in the body to update the hierarchy relationship.
400	Hierarchy relationship invalid - loop detected. Parent branch <{parent_branch_identifier}> is the child branch of <{existing_branch.branch_identifier}>.
404	Branch <branch_identifier> not found.
500	Error updating branch with branch_identifier: <{branch_identifier}>.

Errors not encapsulated in this custom error list can be interpreted as standard REST RFC errors.

Example Request

import requests

headers = {
    'Authorization': 'Bearer {}'.format(REGGORA_AUTH_TOKEN),
    'integration': '{}'.format(REGGORA_INTEGRATION_KEY)
}

response = requests.put('https://sandbox.reggora.io/lender/branch/<branch_identifier>?update_hierarchy=false', headers=headers)

Example Response

{
    "data": {
        "branch": {
            "branch_id": "5d6ecfdb69655808d5b3d012",
            "branch_identifier": "test_branch_1",
            "name": "test branch",
            "address": "123 Main St",
            "city": "Boston",
            "state": "MA",
            "ZIP": "90210",
            "branch_classification": "retail",
            "is_joint_venture": false,
            "contact_phone_number": "555-555-5555",
            "contact_email": "email@testreggora.com",
            "loan_officers": [
                {
                "id": "6373c8fcd74957d911629dcf",
                "email": "email@testreggora.com",
                "firstname": "Homer",
                "lastname": "Simpson",
                "phone_number": "1234567890",
                "created": "2022-11-15 17:15:50.307000"
                }
            ],
            "parent_branch_identifier": "test_branch_2",
            "exists_in_hierarchy": true
        }
    },
    "status": 200
}

Get Branch

This endpoint fetches a branch

HTTP Request

GET https://sandbox.reggora.io/lender/branch/<branch_identifier>

URL Parameters

Parameter	Description
branch_identifer	The unique identifier of the branch.

Response Body Attributes

Attribute	Description	Type
branch_identifier	Unique identifier	string
name	Branch name	string
address	Street address	string
city	City	string
state	State	string
ZIP	Zipcode	string
branch_classification	Options: [‘retail’, ‘wholesale’]	string
is_joint_venture	Boolean / Default is False	bool
contact_phone_number	Phone number	string
contact_email	Email address	string
loan_officers	List of loan officers	Dict
parent_branch_identifier	The branch identifier of the parent	nullable string
exists_in_hierarchy	Flag if branch is in the lender hierarchy	bool

Loan Officer

Attribute	Description	Type
id	Unique identifier	string
email	Email address	string
firstname	First Name	string
lastname	Last Name	string
phone_number	Phone number	string
created	Date Created UTC	string

Example Request

import requests

headers = {
    'Authorization': 'Bearer {}'.format(REGGORA_AUTH_TOKEN),
    'integration': '{}'.format(REGGORA_INTEGRATION_KEY)
}

response = requests.get('https://sandbox.reggora.io/lender/branch/<branch_identifier>', headers=headers)

Example Response

{
    "data": {
        "branch": {
            "branch_id": "5d6ecfdb69655808d5b3d012",
            "branch_identifier": "test_branch_1",
            "name": "test branch",
            "address": "123 Main St",
            "city": "Boston",
            "state": "MA",
            "ZIP": "90210",
            "branch_classification": "retail",
            "is_joint_venture": false,
            "contact_phone_number": "555-555-5555",
            "contact_email": "email@testreggora.com",
            "loan_officers": [
                {
                "id": "6373c8fcd74957d911629dcf",
                "email": "email@testreggora.com",
                "firstname": "Homer",
                "lastname": "Simpson",
                "phone_number": "1234567890",
                "created": "2022-11-15 17:15:50.307000"
                }
            ],
            "parent_branch_identifier": "test_branch_2",
            "exists_in_hierarchy": true
        }
    },
    "status": 200
}