CRM

Find an existing CRM record by NMLS id

GET
/v1/crm/records/by-nmls

Authorization

x-api-key<token>

In: header

Query Parameters

nmlsId*string

Bare NMLS id.

Length1 <= length
entityTypes?string

Comma-separated entity types to match (default: all).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/crm/records/by-nmls?nmlsId=string"
{
  "data": {
    "entityId": "string",
    "entityType": "lo"
  }
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}