Vendors

Get All Vendors

This endpoint returns all the vendors associated with the requesting lender.

HTTP Request

GET https://sandbox.reggora.io/lender/vendors

Query Parameters

Parameter	Default	Description
offset	0	Number of vendors to skip before list gets returned (Used in pagination).
limit	0	Limit of panelists to return (If set to 0 there is no limit).
status	Active,On Hold,Invited,Removed From Panel	Comma separated statuses to filter returned panelists by.

Example Request

import requests

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

response = requests.get('https://sandbox.reggora.io/lender/vendors?offset=<offset>&limit=<limit>&status=<status>', headers=headers)

Example Response

{
    "data": {
        "vendors": [
            {
                "id": "5c33c6b1681f110034effc72",
                "firm_name": "Test Vendor",
                "email": "test@vendor.com",
                "phone": "1231231234",
                "accepting_jobs": true
            },
            "..."
        ]
    },
    "status": 200
}

The "..." placeholder indicates additional entries elided for brevity.

Get Vendors By Zone

This endpoint returns the vendors associated with the requesting lender filtered by zip code.

HTTP Request

POST https://sandbox.reggora.io/lender/vendors/by_zone

Query Parameters

Parameter	Default	Description
offset	0	Number of vendors to skip before list gets returned (Used in pagination).
limit	0	Limit of panelists to return (If set to 0 there is no limit).
status	Active,On Hold,Invited,Removed From Panel	Comma separated statuses to filter returned panelists by.

Request Body Parameters

Parameter	Description	Required
zones	List of zip codes you are interested in filtering by	True

Example Request

import requests

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

body = {
    'zones': ['02806', '02807', '03102']
}

response = requests.post('https://sandbox.reggora.io/lender/vendors/by_zone?offset=<offset>&limit=<limit>&status=<status>   ', json=body, headers=headers)

Example Response

{
    "data": {
        "vendors": [
            {
                "id": "5c33c6b1681f110034effc72",
                "firm_name": "Test Vendor",
                "email": "test@vendor.com",
                "phone": "1231231234",
                "accepting_jobs": true
            },
            "..."
        ]
    },
    "status": 200
}

Get Vendors By Branch

This endpoint returns the vendors associated with the requesting lender filtered by branch.

HTTP Request

GET https://sandbox.reggora.io/lender/vendors/branch

Query Parameters

Parameter	Default	Description
branch_id	None	Filter the vendor panel by the branch they are affiliated with

Example Request

import requests

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

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

Example Response

{
    "data": {
        "vendors": [
            {
                "id": "5c33c6b1681f110034effc72",
                "firm_name": "Test Vendor",
                "email": "test@vendor.com",
                "phone": "1231231234",
                "accepting_jobs": true
            },
            "..."
        ]
    },
    "status": 200
}

Get Vendor By ID

This endpoint takes a vendor ID as a URL parameter and returns the corresponding vendor.

HTTP Request

GET https://sandbox.reggora.io/lender/vendor/<vendor_id>

URL Parameters

Parameter	Description
vendor_id	The ID of the vendor

Example Request

import requests

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

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

Example Response

{
    "data": {
        "vendor": {
            "id": "5c33c6b1681f110034effc72",
            "firm_name": "Test Vendor",
            "email": "test@vendor.com",
            "phone": "1231231234",
            "accepting_jobs": true,
            "lender_coverage": [
                {
                    "county": "001",
                    "state": "44",
                    "zip": "02806"
                },
                "..."
            ]
        }
    },
    "status": 200
}

Add Vendor

This endpoint adds a vendor to your lender. If they are not already signed up for the Reggora platform they will receive an email asking them to create an account.

HTTP Request

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

URL Parameters

Parameter	Description	Required
firm_name	The firm name	True
firstname	The first name of the main contact at the firm	True
lastname	The last name of the main contact at the firm	True
email	The firm email	True
phone	The firm phone	True

Example Request

import requests

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

body = {
    'firm_name': 'Appraisal Firm',
    'firstname': 'Fake',
    'lastname': 'Appraiser',
    'email': 'fake@appraiser.com',
    'phone': '1212312334',
}

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

Example Response

{
    "data": "5c33c6b1681f110034effc72",
    "status": 200
}

Edit Vendor

This endpoint edits a vendor. Only the fields that are in the request body will be updated.

HTTP Request

PUT https://sandbox.reggora.io/lender/vendor/<vendor_id>

URL parameters

Parameter	Description
vendor_id	The ID of the vendor

Request Body Parameters

Parameter	Description	Required
firm_name	The firm name	False
firstname	The first name of the main contact at the firm	False
lastname	The last name of the main contact at the firm	False
email	The firm email	False
phone	The firm phone	False

Example Request

import requests

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

body = {
    "firm_name": "New Vendor",
    "firstname": "Vendor",
    "lastname": "Admin",
    "email": "vendor@reggora.com",
    "phone": "4567891011"
}

response = requests.put('https://sandbox.reggora.io/lender/vendor/<vendor_id>', headers=headers)

Example Response

{
    "data": "5c33c6b1681f110034effc72",
    "status": 200
}

Delete Vendor

This endpoint removes a vendor from your lender panel.

HTTP Request

DELETE https://sandbox.reggora.io/lender/vendor/<vendor_id>

URL parameters

Parameter	Description
vendor_id	The ID of the vendor

Example Request

import requests

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

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

Example Response

{
    "data": "Your vendor has been removed",
    "status": 200
}