Create Caller ID Risk Check

Starts a Caller ID Risk Check of 1 to 1,000 phone numbers, purchased in the contact center or not. The contact center is charged for every number checked.

Processing is asynchronous: the endpoint returns the risk check with status processing. Poll Get Caller ID Risk Check (GET /api/v4/numbers/risk_checks/{risk_check_id}) until the status is finished, then read the per-number results with Get Caller ID Risk Check results (GET /api/v4/numbers/risk_checks/{risk_check_id}/results).

Phone numbers are normalized to digits before the check. A value that is not a phone number, a number repeated after normalization, an empty list or more than 1,000 numbers rejects the whole request with 422; nothing is checked or charged. While a risk check created through this endpoint in the last 30 minutes is still processing, a new one is rejected with 409. Runs of scheduled reports do not count towards that limit. When the risk check service refuses the submission, the endpoint returns 503 and no risk check is created.

Available only if Caller ID Risk Check and its API access are enabled for the contact center. Requires an API key with the numbers.risk_checks.manage scope.

Body Params
phone_numbers
array of strings
required
length between 1 and 1000

Phone numbers to check, in E.164 format with or without the leading plus sign. Spaces, dots, dashes and brackets are ignored.

phone_numbers*
Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json