Retrieve a signal

curl https://api.middesk.com/v1/signals/id \
     -u "<username>:<password>"

{
  "object": "signal",
  "id": "f6a7b8c9-d0e1-2345-f012-3456789abcde",
  "name": "Acme Corporation",
  "created_at": "2025-01-07T12:00:00Z",
  "tin": "12-3456789",
  "external_id": "ext-12345",
  "model_slug": "verify",
  "score": 0.85,
  "batch_id": "a7b8c9d0-e1f2-3456-0123-456789abcdef",
  "requester": {
    "id": "b8c9d0e1-f2a3-4567-1234-56789abcdef0",
    "type": "Account",
    "name": "Example Account"
  },
  "reasons": [
    {
      "category": "identification",
      "group": "name",
      "description": "Business name verified",
      "code": "V101",
      "importance": 1.1
    }
  ],
  "addresses": [
    "123 Main Street, San Francisco, CA 94105"
  ],
  "people": [
    "people"
  ]
}

Authentication

AuthorizationBasic

Basic authentication of the form Basic <username:password>.

Path parameters

idstringRequired

Signal ID

Response

signal found

objectstring

idstringformat: "uuid"

namestring

created_atdatetime

tinstring or null

external_idstring or null

model_slugstring or null

scoredouble or null

business_idstring or nullformat: "uuid"

batch_idstring or nullformat: "uuid"

requesterobject or null

reasonslist of objects or null

addresseslist of strings or null

peoplelist of strings or null

Authentication

Path parameters

Response

Errors