Client configurations

Your client configurations will tell you the appraisal companies you can request an order from and to which products and what payment methods, the property types references, the users you can add as parties (processors and loan officers) to the order, and the branches available, if any.

The client configuration model

The client configuration model contains all the information about the configurations you'll need at the time of requesting an order.

Properties

Name
id
Type
string
Description
Unique identifier for the message.
Name
branches
Type
array
Description
The list of branches available for the client.
Name
companies
Type
array
Description
The list of companies available for the client.
Name
property_types
Type
array
Description
The message content.
Name
branches
Type
array
Description
An array of reaction objects associated with the message.

GET/v1/messages

List your client configurations

This endpoint allows you to retrieve your client configurations.

Required attributes

Name
client_id
Type
string
Description
Your client id.

Request

GET

/v1/clients/{client_id}/configurations

curl -G https://api.protocol.chat/v1/messages \
  -H "Authorization: Bearer {token}" \
  -d conversation_id=xgQQXg3hrtjh7AvZ \
  -d limit=10

Response

{
  "id": "421edb77-207a-4880-a2f0-5f90d733e93a",
  "branches": [
    "id": "421edb77-207a-4880-a2f0-5f90d733e93a",
    "name": "Main Branch"
  ],
  "companies": [
    {
      "company_id": "d52663d2-54f2-4fd9-b515-e830de8e3888",
      "company_name": "eValuation ZONE, Inc.",
      "payment_methods": [
        "payment_link",
        "invoice",
        "credit_card"
      ],
      "products": [
        {
          "id": "0b25248f-89b2-4871-90b0-03634af9f363",
          "name": "CONV SFR (FNMA 1004)",
          "service_type": "residential_appraisals",
          "follow_up": true
        },
        {
          "id": "d3fbe923-bf1a-4a3b-b0f9-b68ae515864d",
          "name": "1004D Combo (Final Inspect + Recert)",
          "service_type": "residential_appraisals",
          "follow_up": false
        }
      ]
    }
  ],
  "parties": [
    {
      "id": "c94f7a75-1621-4975-8c0f-efe866a4499d",
      "name": "John Doe"
    }
  ],
  "property_types": [
    {
      "id": "a9fee2ec-3732-455b-90df-47b744d8ce4f",
      "name": "SFR",
      "slug": "sfr"
    },
    {
      "id": "3955a273-b027-4b0d-90d2-7c77e0cfc259",
      "name": "Condo",
      "slug": "condo"
    }
  ]
}