Score a business profile
Score a business using Signal with the Middesk Dashboard or API.
Score in the Dashboard
In both the Dashboard and through the POST /signals endpoint, you can also run a batch of businesses past Signal. To retrieve the results, use the GET /signals endpoint.
Score using the API
The Middesk quickstart walks you through how to obtain your API key and make your first API request. To learn more about the Middesk testing environment, webhooks, and authentication, see Implement webhooks .
To score using the API:
-
The required inputs for the Signal product are the business name and associated address. For additional insights, also include optional fields such as TIN/EIN (taxpayer identification number) and associated people for each business.
-
If your application flow collects multiple addresses (like mailing versus physical addresses) and associated business owners/individuals, you can also pass them through the POST /signals endpoint.
-
If you plan to store the Signal report as an object in your database with your identifier, pass your external ID in the API request; otherwise, you can use the returned Signal ID for reference.
Receive the Signal response
The POST /signals endpoint is instant, meaning you receive an immediate and complete response. Middesk does not provide webhooks for the Signal endpoints as it’s a synchronous workflow.
Middesk recommends storing the Signal ID for future reference, along with other relevant fields like reason codes, external ID, or timestamps. If needed, you can always retrieve the complete Signal response later by calling the GET /signals endpoint.
