Lenders

Get lender by ID

getapi.modelmatch.com/v1/lenders/{id}

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Path parameters

idstringrequired

Lender canonical-name ID

Responses

200objectLender detail

Show attributes

dataobjectrequired

Show child attributes

canonicalNamestring | null

displayNamestring | null

idstringrequired

totalDocumentsnumber | null

404objectLender not found

413objectResponse payload too large

curl -X GET "https://api.modelmatch.com/v1/lenders/<id>" \
  -H "x-api-key: $MODEL_MATCH_API_KEY"

import { createClient } from "@model-match/api";

const client = createClient({ apiKey: process.env.MODEL_MATCH_API_KEY });

const { data, error } = await client.lenders.get({
  path: {
    id: "<id>"
  }
});

import os
import requests

res = requests.get(
    "https://api.modelmatch.com/v1/lenders/<id>",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
)
data = res.json()

200 response

{
  "data": {
    "canonicalName": "<string>",
    "displayName": "<string>",
    "id": "<string>",
    "totalDocuments": 123.45
  }
}