Scan Single Phone Number

post

https://dialright-api.calleridreputation.com/v1/scan

Scrubs a single phone number against DialRight data sources. Must be called with an organization API token (Authorization: Bearer); web-app sessions are rejected.

Rate limit: 64 requests per second per organization API token. For more than a handful of numbers use POST /v1/scan/bulk instead of looping this endpoint.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

data_sources

array of objects | null

data_sources

Allowed:

dr_score_attributes

array of objects | null

dr_score_attributes

Allowed:

contact

object

required

phone_number_format

string

enum

required

Format used when returning phone numbers in scan results.

Allowed:

test_mode

boolean

Defaults to false

Dry run. When true the request skips the funds check, does not charge the organization, and vendor lookups return synthetic placeholder data, so result values are not real. Use it to validate request shape and parsing; set false (default) for real results. Real scans bill the organization per number and per data source (see metadata.cost).

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

200Scanned successfully.

400Validation failed (format, phone number, date, sources, or attributes).

401Missing or invalid credentials, or insufficient permissions for this resource.

402Insufficient organization funds to complete the request.

403Authenticated, but not allowed to perform this action.

429Rate limit exceeded. Limits per organization API token, per endpoint: POST /v1/scan 64/s; POST /v1/scan/bulk 1/s; other /v1 endpoints 200 per 45 s. Wait Retry-After seconds.

500Unexpected server error.